diff --git a/README.md b/README.md index b0f586226..abc68101b 100644 --- a/README.md +++ b/README.md @@ -13,43 +13,28 @@ With Zeppelin, you can build distributed applications, protocols and organizatio ## Getting Started Zeppelin integrates with [Truffle](https://github.com/ConsenSys/truffle), an Ethereum development environment. Please install Truffle and initialize your project with `truffle init`. + ```sh -npm install -g truffle +npm install -g truffle@beta mkdir myproject && cd myproject truffle init ``` To install the Zeppelin library, run: ```sh -npm i zeppelin-solidity +truffle install zeppelin ``` -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 `installed_contracts` folder. You can use the contracts in the library like so: ```js -import "./zeppelin/Ownable.sol"; +import 'zeppelin/ownership/Ownable.sol'; contract MyContract is Ownable { ... } ``` -> NOTE: The current distribution channel is npm, which is not ideal. [We're looking into providing a better tool for code distribution](https://github.com/OpenZeppelin/zeppelin-solidity/issues/13), 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: - -```js -import "zeppelin-solidity/contracts/Ownable.sol"; - -contract MyContract is Ownable { - ... -} -``` - -For more info see [the Truffle Beta package management tutorial](http://truffleframework.com/tutorials/package-management). - - ## Security Zeppelin is meant to provide secure, tested and community-audited code, but please use common sense when doing anything that deals with real money! We take no responsibility for your implementation decisions and any security problem you might experience.