From 250572f48df2202e7df468a1bc4995c709553cfa Mon Sep 17 00:00:00 2001 From: Francisco Giordano Date: Thu, 18 Jan 2018 17:58:41 -0300 Subject: [PATCH] add note about not following semver --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2e441d468..d5f555139 100644 --- a/README.md +++ b/README.md @@ -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