Update README.md

frangio-patch-2
Francisco 1 year ago committed by GitHub
parent f92dce51ed
commit 0e1d262872
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 14
      README.md

@ -27,7 +27,7 @@
### Installation ### Installation
#### Hardhat, Truffle (npm) #### Hardhat (npm)
``` ```
$ npm install @openzeppelin/contracts $ npm install @openzeppelin/contracts
@ -35,18 +35,18 @@ $ npm install @openzeppelin/contracts
#### Foundry (git) #### 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 $ forge install OpenZeppelin/openzeppelin-contracts
``` ```
Add `@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/` in `remappings.txt.` Add `@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/` in `remappings.txt.`
> [!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.
### Usage ### Usage
Once installed, you can use the contracts in the library by importing them: Once installed, you can use the contracts in the library by importing them:

Loading…
Cancel
Save