Skip to content

Commit a33fd7c

Browse files
committed
docs: update for v2
1 parent 4bb67e1 commit a33fd7c

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
An alternative TypeScript standard library with better type definitions.
44

5-
[See the v2 branch for 2.0.0 that supports TypeScript 4.5.](https://github.com/uhyo/better-typescript-lib/tree/v2)
6-
75
## The Problem
86

97
While it is well known that TypeScript is not _very_ type safe due to the existence of `any` and other pitfalls, TypeScript's built-in type definitions are also to blame for that unsafety. For example, it is handy but very unsafe that the return type of `JSON.parse` is `any`.
@@ -20,12 +18,12 @@ This package also includes other improved, stricter type definitions.
2018

2119
You only need to install `better-typescript-lib`. Additional configuration is not needed; your TypeScript project automatically use `better-typescript-lib` definitions.
2220

23-
Currently v2 is beta-released.
24-
2521
```sh
26-
npm i -D better-typescript-lib@2.0.0-beta
22+
npm i -D better-typescript-lib
2723
```
2824

25+
[If you are using TypeScript 4.4 or prior, see the v1 branch.](https://github.com/uhyo/better-typescript-lib/tree/v1)
26+
2927
### How it works
3028

3129
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.
@@ -36,7 +34,7 @@ Starting from TypeScript 4.5, the TypeScript compiler detects existence of `@typ
3634
| --------------------- | --------------- |
3735
| 2.0.0 | TS 4.5 or later |
3836

39-
For TS 4.4 and lower, see `v1` branch.
37+
[If you are using TypeScript 4.4 or prior, see the v1 branch.](https://github.com/uhyo/better-typescript-lib/tree/v1)
4038

4139
## Concepts
4240

0 commit comments

Comments
 (0)