Compare commits

...

3 Commits

Author SHA1 Message Date
3bb7ec72d0 Update README.md 2023-10-04 21:21:25 -03:00
d03ead5436 Update README.md 2023-10-04 21:19:32 -03:00
0e1d262872 Update README.md 2023-10-04 21:17:51 -03:00

View File

@ -27,7 +27,7 @@
### Installation
#### Hardhat, Truffle (npm)
#### Hardhat (npm)
```
$ npm install @openzeppelin/contracts
@ -35,18 +35,19 @@ $ npm install @openzeppelin/contracts
#### Foundry (git)
> [!WARNING]
> When installing via git, it is a common error to use the `master` branch. This is a development branch that should be avoided in favor of tagged releases. The release process involves security measures that the `master` branch does not guarantee.
> [!WARNING]
> Foundry installs the latest version initially, but subsequent `forge update` commands will use the `master` branch.
```
$ forge install OpenZeppelin/openzeppelin-contracts
```
Add `@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/` in `remappings.txt.`
> [!WARNING]
> <details>
> <summary>Avoid installing the `master` branch.</summary>
> When installing via git, it is a common error to use the `master` branch. This is a development branch that should be avoided in favor of tagged releases. The release process involves security measures that the `master` branch does not guarantee.
> Note that `forge install` gets the latest version initially, but subsequent `forge update` commands will use the `master` branch.
> </details>
### Usage
Once installed, you can use the contracts in the library by importing them: