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 `_.