Skip to content

Commit 42d5c26

Browse files
committed
Documentation
1 parent f3e559b commit 42d5c26

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

readme.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,13 +357,23 @@ The TypeBox compiler is tested against the [Official JSON Schema Test Suite](htt
357357

358358
## Versions
359359

360-
TypeBox provides two distinct versions that span two generations of the TypeScript compiler.
360+
TypeBox ships two distinct versions that span two generations of the TypeScript compiler.
361+
362+
```bash
363+
$ npm install typebox # 1.x
364+
365+
$ npm install @sinclair/typebox # 0.x
366+
```
367+
368+
These versions are summarized with the following.
361369

362370
| TypeBox | TypeScript | Description |
363371
| :--- | :--- | :--- |
364372
| 1.x | 6.0 - 7.0+ | **Latest.** Developed against the TypeScript 7 native compiler. Provides advanced type inference and native JSON Schema 2020-12 support. Includes backwards compatibility with `0.x` types. **ESM only.** |
365373
| 0.x | 5.0 - 6.0 | **LTS.** Developed against older TypeScript versions and actively maintained under Long Term Support. Compatible with both **ESM and CJS**. Issues should be submitted to the [Sinclair TypeBox](https://github.com/sinclairzx81/sinclair-typebox) repository. |
366374

375+
New applications should use 1.x. The 0.x version is maintained under LTS support for existing users.
376+
367377
## Contribute
368378

369379
TypeBox is open to community contribution. Please ensure you submit an issue before submitting a pull request. The TypeBox project prefers open community discussion before accepting new features.

0 commit comments

Comments
 (0)