From cb4d5a7107a8dc0213b19aef8cf6148b3df9eae7 Mon Sep 17 00:00:00 2001 From: Andreas Hocevar Date: Mon, 5 Jul 2021 15:02:56 +0200 Subject: [PATCH] Update types info in README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 45d7e9ae72..670651fddb 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ The untranspiled sources in the `src/` folder are JSDoc type annotated. For appl ## TypeScript support -When authoring in TypeScript, we recommend you try out the types that are included in the `ol` package. To use these types, make sure you have the following entry for `@types/ol` in your `package.json`'s `devDependencies` section: +When authoring in TypeScript, we recommend you try out the types that are included in the `ol` package. To use these types, add the following entry for `@types/ol` to your `package.json`'s `devDependencies` section: ``` { ... @@ -116,7 +116,9 @@ When authoring in TypeScript, we recommend you try out the types that are includ } } ``` -These are auto-generated with the TypeScript compiler, and will be the default in future versions. Alternatively, you can use third-party types from [Definitely Typed](https://definitelytyped.org) (`npm install @types/ol`) or from [hanreev/types-ol](https://github.com/hanreev/types-ol). +Make sure to run `npm install` before and after adding that entry. + +These types are auto-generated by the TypeScript compiler, and will be the only type source in future versions. For now, you can still use third-party types from [Definitely Typed](https://definitelytyped.org) (`npm install @types/ol`) or from [hanreev/types-ol](https://github.com/hanreev/types-ol). ## Supported Browsers