Skip to content

Commit 841ea4d

Browse files
committed
docs: v2.5.0
1 parent db3431e commit 841ea4d

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This package also includes other improved, stricter type definitions.
1818

1919
## Installation
2020

21-
You only need to install `better-typescript-lib`. Additional configuration is not needed; your TypeScript project automatically use `better-typescript-lib` definitions.
21+
You only need to install `better-typescript-lib`. For npm and yarn, additional configuration is not needed; your TypeScript project automatically use `better-typescript-lib` definitions. For pnpm, see below.
2222

2323
```sh
2424
npm i -D better-typescript-lib
@@ -28,9 +28,9 @@ npm i -D better-typescript-lib
2828

2929
### How it works
3030

31-
Starting from TypeScript 4.5, the TypeScript compiler detects existence of `@typescript/xxx` packages (e.g. `@typescript/es2015`) and uses them instead of the built-in definitions. By installing `better-typescript-lib`, these package names are mapped to corresponding `@better-typescript-lib/xxx` packages.
31+
Starting from TypeScript 4.5, the TypeScript compiler detects existence of `@typescript/lib-xxx` packages (e.g. `@typescript/lib-es2015`) and uses them instead of the built-in definitions. By installing `better-typescript-lib`, these package names are mapped to corresponding `@better-typescript-lib/xxx` packages.
3232

33-
### with pnpm
33+
### With pnpm
3434

3535
With pnpm, you must append the following line to the `.npmrc` file:
3636

@@ -46,6 +46,7 @@ This is because, unlike npm and yarn, by default pnpm does not allow your source
4646

4747
| better-typescript-lib | TypeScript |
4848
| --------------------- | --------------- |
49+
| 2.5.0 | TS 5.2 or later |
4950
| 2.4.0 | TS 5.1 or later |
5051
| 2.3.0 | TS 5.0 or later |
5152
| 2.2.0 | TS 4.9 or later |

0 commit comments

Comments
 (0)