From a5a1be72197be4a619653b67c7345c31ff6da1c8 Mon Sep 17 00:00:00 2001 From: Boris Kostenko Date: Sat, 7 Oct 2017 23:21:58 +0300 Subject: [PATCH 1/4] Fixing docs issue #459 --- docs/source/getting-started.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index 6f84f870a..b700dd402 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -11,7 +11,7 @@ To install the Zeppelin library, run:: npm i zeppelin-solidity -After that, you'll get all the library's contracts in the contracts/zeppelin folder. You can use the contracts in the library like so:: +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:: import "zeppelin-solidity/contracts/Ownable.sol"; From 0d89e99ceb6fd69484f4df0280833a92fcc66108 Mon Sep 17 00:00:00 2001 From: Boris Kostenko Date: Sat, 7 Oct 2017 23:24:23 +0300 Subject: [PATCH 2/4] Fix contracts path issue --- docs/source/getting-started.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index b700dd402..0b65460d9 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -13,7 +13,7 @@ To install the Zeppelin library, run:: 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:: - import "zeppelin-solidity/contracts/Ownable.sol"; + import "zeppelin-solidity/contracts/ownership/Ownable.sol"; contract MyContract is Ownable { ... @@ -27,7 +27,7 @@ Truffle Beta Support """""""""""""""""""""""" We also support Truffle Beta npm integration. If you're using Truffle Beta, the contracts in ``node_modules`` will be enough, so feel free to delete the copies at your ``contracts`` folder. If you're using Truffle Beta, you can use Zeppelin contracts like so:: - import "zeppelin-solidity/contracts/Ownable.sol"; + import "zeppelin-solidity/contracts/ownership/Ownable.sol"; contract MyContract is Ownable { ... From 9dcf37dd19720ccb608dabb4c5d40cc23fddf4b9 Mon Sep 17 00:00:00 2001 From: Boris Kostenko Date: Sat, 7 Oct 2017 23:37:37 +0300 Subject: [PATCH 3/4] align docs getting-started.rst with README.md --- docs/source/getting-started.rst | 26 +++++++------------------- 1 file changed, 7 insertions(+), 19 deletions(-) diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index 0b65460d9..465ae04f9 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -1,15 +1,19 @@ Getting Started ============================================= -Zeppelin integrates with `Truffle `_, an Ethereum development environment. Please install Truffle and initialize your project with ``truffle init``:: +OpenZeppelin integrates with `Truffle `_, an Ethereum development environment. Please install Truffle and initialize your project with ``truffle init``:: npm install -g truffle mkdir myproject && cd myproject truffle init -To install the Zeppelin library, run:: +To install the OpenZeppelin library, run:: + + npm install zeppelin-solidity + + # If you are using yarn, add dependency like this - + yarn add zeppelin-solidity - npm i zeppelin-solidity 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:: @@ -18,19 +22,3 @@ After that, you'll get all the library's contracts in the `node_modules/zeppelin contract MyContract is Ownable { ... } - -.. epigraph:: - - NOTE: The current distribution channel is npm, which is not ideal. `We're looking into providing a better tool for code distribution `_ , and ideas are welcome. - -Truffle Beta Support -"""""""""""""""""""""""" -We also support Truffle Beta npm integration. If you're using Truffle Beta, the contracts in ``node_modules`` will be enough, so feel free to delete the copies at your ``contracts`` folder. If you're using Truffle Beta, you can use Zeppelin contracts like so:: - - import "zeppelin-solidity/contracts/ownership/Ownable.sol"; - - contract MyContract is Ownable { - ... - } - -For more info see the `Truffle Beta package management tutorial `_. From 2cb2799a512a80252074928a1c56acb0a5cfcf02 Mon Sep 17 00:00:00 2001 From: Boris Kostenko Date: Sat, 7 Oct 2017 23:44:43 +0300 Subject: [PATCH 4/4] align docs developer-resources.rst with README.md --- docs/source/developer-resources.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/developer-resources.rst b/docs/source/developer-resources.rst index 802d9ce0f..3b4dbc46c 100644 --- a/docs/source/developer-resources.rst +++ b/docs/source/developer-resources.rst @@ -1,11 +1,11 @@ Developer Resources ============================================= -Building a distributed application, protocol or organization with Zeppelin? +Building a distributed application, protocol or organization with OpenZeppelin? -Ask for help and follow progress at: https://zeppelin-slackin.herokuapp.com/ +Ask for help and follow progress at: https://slack.openzeppelin.org/ -Interested in contributing to Zeppelin? +Interested in contributing to OpenZeppelin? * Framework proposal and roadmap: https://medium.com/zeppelin-blog/zeppelin-framework-proposal-and-development-roadmap-fdfa9a3a32ab#.iain47pak * Issue tracker: https://github.com/OpenZeppelin/zeppelin-solidity/issues