Skip to content

Commit

Permalink
Add note about remappings
Browse files Browse the repository at this point in the history
  • Loading branch information
ericglau committed Oct 27, 2023
1 parent 582dc17 commit 5484858
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ Set the following in `remappings.txt`, replacing any previous definitions of the
@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/
```

> **Note**
> The above remappings mean that both `@openzeppelin/contracts/` and `@openzeppelin/contracts-upgradeable/` are coming from the `openzeppelin-contracts-upgradeable` submodule and its subdirectories (which includes its own transitive copy of `openzeppelin-contracts` of the same release version number). Particularly, any copies of `openzeppelin-contracts` that you install separately are NOT used.
## Version Limitations

This library only supports proxy contracts and upgrade interfaces from OpenZeppelin Contracts 5.0 or higher.
Expand Down

0 comments on commit 5484858

Please sign in to comment.