NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update remappings and install instructions for Foundry on docs site (#4498)

Browse Source 
Co-authored-by: ernestognw <ernestognw@gmail.com>
This commit is contained in:
Francisco
2023-08-08 23:22:57 -03:00
committed by GitHub
parent cb0ffefe2f
commit 8643fd45fd
8 changed files with 29 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/modules/ROOT/pages/index.adoc
View File

@ -11,11 +11,25 @@
[[install]]
=== Installation
==== Hardhat, Truffle (npm)
```console
$ npm install @openzeppelin/contracts
```
OpenZeppelin Contracts features a xref:releases-stability.adoc#api-stability[stable API], which means your contracts won't break unexpectedly when upgrading to a newer minor version.
OpenZeppelin Contracts features a xref:releases-stability.adoc#api-stability[stable API], which means that your contracts won't break unexpectedly when upgrading to a newer minor version.
==== 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.
```console
$ forge install OpenZeppelin/openzeppelin-contracts
```
Add `@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/` in `remappings.txt.`
[[usage]]
=== Usage