Skip to content

Commit

Permalink
add note about not following semver
Browse files Browse the repository at this point in the history
  • Loading branch information
frangio committed Jan 18, 2018
1 parent ff9e9c4 commit 250572f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@ truffle init

To install the OpenZeppelin library, run the following in your Solidity project root directory:
```sh
npm init
npm install zeppelin-solidity
npm init -y
npm install -E zeppelin-solidity
```

**Note that OpenZeppelin does not currently follow semantic versioning.** You may encounter breaking changes upon a minor version bump. We recommend pinning the version of OpenZeppelin you use, as done by the `-E` (`--save-exact`) option.

After that, you'll get all the library's contracts in the `node_modules/zeppelin-solidity/contracts` folder. You can use the contracts in the library like so:

```js
Expand Down

0 comments on commit 250572f

Please sign in to comment.