Browse Source

update README on new code distribution

Manuel Araoz 8 years ago
parent
commit
9006f89f9f
1 changed files with 5 additions and 20 deletions
  1. 5 20
      README.md

+ 5 - 20
README.md

@@ -13,43 +13,28 @@ With Zeppelin, you can build distributed applications, protocols and organizatio
 ## Getting Started
 ## 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`.
 Zeppelin integrates with [Truffle](https://github.com/ConsenSys/truffle), an Ethereum development environment. Please install Truffle and initialize your project with `truffle init`.
+
 ```sh
 ```sh
-npm install -g truffle
+npm install -g truffle@beta
 mkdir myproject && cd myproject
 mkdir myproject && cd myproject
 truffle init
 truffle init
 ```
 ```
 
 
 To install the Zeppelin library, run:
 To install the Zeppelin library, run:
 ```sh
 ```sh
-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:
-
-```js
-import "./zeppelin/Ownable.sol";
-
-contract MyContract is Ownable {
-  ...
-}
+truffle install zeppelin
 ```
 ```
 
 
-> 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:
+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
 ```js
-import "zeppelin-solidity/contracts/Ownable.sol";
+import 'zeppelin/ownership/Ownable.sol';
 
 
 contract MyContract is Ownable {
 contract MyContract is Ownable {
   ...
   ...
 }
 }
 ```
 ```
 
 
-For more info see [the Truffle Beta package management tutorial](http://truffleframework.com/tutorials/package-management).
-
-
 ## Security
 ## 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.
 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.