Skip to content

Commit 91a0a0d

Browse files
committed
Add Readme notice about the use of NPM tags
1 parent 04e683b commit 91a0a0d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,29 @@
2020
2121
## Overview
2222

23+
### Release tags
24+
25+
We use NPM tags to clearly distinguish between audited and non-audited versions of our package:
26+
27+
| Tag | Purpose | Description |
28+
| :--------- | :----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
29+
| **latest** | ✅ Audited releases | Stable, audited versions of the package. This is the **default** version installed when users run `npm install @openzeppelin/contracts`. |
30+
| **dev** | 🧪 Final but not audited | Versions that are finalized and feature-complete but have **not yet been audited**. This version is fully tested, can be used in production and is covered by the bug bounty. |
31+
| **next** | 🚧 Release candidates | Pre-release versions that are **not final**. Used for testing and validation before the version becomes a final `dev` or `latest` release. |
32+
2333
### Installation
2434

2535
#### Hardhat (npm)
2636

2737
```
2838
$ npm install @openzeppelin/contracts
2939
```
40+
→ Installs the latest audited release (`latest`).
41+
42+
```
43+
$ npm install @openzeppelin/contracts@dev
44+
```
45+
→ Installs the latest unaudited release (`dev`).
3046

3147
#### Foundry (git)
3248

0 commit comments

Comments
 (0)