Browse Source

Merge pull request #487 from limexp/fix/docs

fix docs issue #459 and align with README.md
Alejandro Santander 8 years ago
parent
commit
d919f0dde2
2 changed files with 10 additions and 22 deletions
  1. 3 3
      docs/source/developer-resources.rst
  2. 7 19
      docs/source/getting-started.rst

+ 3 - 3
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

+ 7 - 19
docs/source/getting-started.rst

@@ -1,37 +1,25 @@
 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``::
+OpenZeppelin integrates with `Truffle <https://github.com/ConsenSys/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";
 
-	contract MyContract is Ownable {
-	  ...
-	}
-
-.. epigraph::
+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::
 
-   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::
-
-	import "zeppelin-solidity/contracts/Ownable.sol";
+	import "zeppelin-solidity/contracts/ownership/Ownable.sol";
 
 	contract MyContract is Ownable {
 	  ...
 	}
-
-For more info see the `Truffle Beta package management tutorial <http://truffleframework.com/tutorials/package-management/>`_.