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 diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index 0381c2cf7..89c47ed9a 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -1,37 +1,25 @@ 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 init # follow instructions - npm i zeppelin-solidity + npm install 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:: + # If you are using yarn, add dependency like this - + yarn add zeppelin-solidity - import "zeppelin-solidity/contracts/Ownable.sol"; + +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:: - - 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/Ownable.sol"; - - contract MyContract is Ownable { - ... - } - -For more info see the `Truffle Beta package management tutorial `_.