NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

make some updates on the get started guide (#1725)

Browse Source
This commit is contained in:
Francisco Giordano
2019-04-23 20:20:01 -03:00
committed by Nicolás Venturo
parent 97a9ca5681
commit 4a0a67b04c
1 changed files with 11 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/get-started.md
View File

@ -3,24 +3,22 @@ id: get-started
title: Get Started title: Get Started
--- ---
OpenZeppelin can be installed directly into your existing node.js project with `npm install --save-exact openzeppelin-solidity`, but OpenZeppelin also integrates directly with [Truffle](https://github.com/ConsenSys/truffle), an Ethereum development environment, which we'll use to get started. OpenZeppelin can be installed directly into your existing node.js project with `npm install openzeppelin-solidity`. We will use [Truffle](https://github.com/ConsenSys/truffle), an Ethereum development environment, to get started.
Please install Truffle and initialize your project: Please install Truffle and initialize your project:
```sh ```sh
$ npm install -g truffle $ mkdir myproject
$ mkdir myproject && cd myproject $ cd myproject
$ truffle init $ npm install truffle
$ npx truffle init
``` ```
To install the OpenZeppelin library, run the following in your Solidity project root directory: To install the OpenZeppelin library, run the following in your Solidity project root directory:
```sh ```sh
$ npm init -y $ npm install openzeppelin-solidity
$ npm install --save-exact openzeppelin-solidity
``` ```
**Note that OpenZeppelin only lightly follows semantic versioning.** You may encounter breaking changes upon a minor version bump. We recommend pinning the version of OpenZeppelin you use by using the `--save-exact` option.
After that, you'll get all the library's contracts in the `node_modules/openzeppelin-solidity/contracts` folder. Because Truffle and other Ethereum development toolkits understand `node_modules`, you can use the contracts in the library like so: After that, you'll get all the library's contracts in the `node_modules/openzeppelin-solidity/contracts` folder. Because Truffle and other Ethereum development toolkits understand `node_modules`, you can use the contracts in the library like so:
```js ```js
@ -35,12 +33,12 @@ contract MyContract is Ownable {
After installing OpenZeppelin, check out the rest of the guides in the sidebar to learn about the different contracts that OpenZeppelin provides and how to use them. After installing OpenZeppelin, check out the rest of the guides in the sidebar to learn about the different contracts that OpenZeppelin provides and how to use them.
- [Learn About Access Control](/api/docs/learn-about-access-control.html) - [Learn About Access Control](learn-about-access-control)
- [Learn About Crowdsales](/api/docs/learn-about-crowdsales.html) - [Learn About Crowdsales](learn-about-crowdsales)
- [Learn About Tokens](/api/docs/learn-about-tokens.html) - [Learn About Tokens](learn-about-tokens)
- [Learn About Utilities](/api/docs/learn-about-utilities.html) - [Learn About Utilities](learn-about-utilities)
You may also want to take a look at the guides which cover several common use cases and good practices: https://blog.zeppelin.solutions/guides/home You may also want to take a look at the guides on our blog, which cover several common use cases and good practices: https://blog.zeppelin.solutions/guides/home.
For example, [The Hitchhiker’s Guide to Smart Contracts in Ethereum](https://blog.zeppelin.solutions/the-hitchhikers-guide-to-smart-contracts-in-ethereum-848f08001f05) will help you get an overview of the various tools available for smart contract development, and help you set up your environment. For example, [The Hitchhiker’s Guide to Smart Contracts in Ethereum](https://blog.zeppelin.solutions/the-hitchhikers-guide-to-smart-contracts-in-ethereum-848f08001f05) will help you get an overview of the various tools available for smart contract development, and help you set up your environment.