From 9dcf37dd19720ccb608dabb4c5d40cc23fddf4b9 Mon Sep 17 00:00:00 2001 From: Boris Kostenko Date: Sat, 7 Oct 2017 23:37:37 +0300 Subject: [PATCH] align docs getting-started.rst with README.md --- docs/source/getting-started.rst | 24 ++++++------------------ 1 file changed, 6 insertions(+), 18 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,36 +1,24 @@ 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 i zeppelin-solidity + npm install 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:: - - import "zeppelin-solidity/contracts/ownership/Ownable.sol"; - - contract MyContract is Ownable { - ... - } - -.. epigraph:: + # If you are using yarn, add dependency like this - + yarn add zeppelin-solidity - 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:: +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/ownership/Ownable.sol"; contract MyContract is Ownable { ... } - -For more info see the `Truffle Beta package management tutorial `_.