Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2fa3176
commit e5ba866
Showing
1 changed file
with
12 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,30 @@ | ||
| # <img src="logo.png" alt="OpenZeppelin" width="400px"> | ||
|
|
||
| [](https://www.npmjs.org/package/openzeppelin-solidity) | ||
| [](https://travis-ci.org/OpenZeppelin/openzeppelin-solidity) | ||
| [](https://coveralls.io/github/OpenZeppelin/openzeppelin-solidity?branch=master) | ||
| # OpenZeppelin EVM Package | ||
|
|
||
| [](https://www.npmjs.org/package/openzeppelin-eth) | ||
| [](https://travis-ci.org/OpenZeppelin/openzeppelin-eth) | ||
|
|
||
| **OpenZeppelin is a library for secure smart contract development.** It provides implementations of standards like ERC20 and ERC721 which you can deploy as-is or extend to suit your needs, as well as Solidity components to build custom contracts and more complex decentralized systems. | ||
|
|
||
| This fork of OpenZeppelin is set up as a **reusable EVM Package**. It is deployed to the kovan, rinkeby, and ropsten test networks, as well as to the main Ethereum network. You can reuse any of the pre-deployed on-chain contracts by simply linking to them using [ZeppelinOS](https://github.com/zeppelinos/zos), or reuse their Solidity source code as with the vanilla version of OpenZeppelin. | ||
|
|
||
| ## Install | ||
|
|
||
| ``` | ||
| npm install openzeppelin-solidity | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| To write your custom contracts, import ours and extend them through inheritance. | ||
|
|
||
| ```solidity | ||
| import 'openzeppelin-solidity/contracts/token/ERC721/ERC721.sol'; | ||
| import 'openzeppelin-solidity/contracts/token/ERC721/ERC721Mintable.sol'; | ||
| contract MyNFT is ERC721, ERC721Mintable { | ||
| } | ||
| npm install openzeppelin-eth | ||
| ``` | ||
|
|
||
| > You need an ethereum development framework for the above import statements to work! Check out these guides for [Truffle] or [Embark]. | ||
| ## Pre-deployed contracts | ||
|
|
||
| On our site you will find a few [guides] to learn about the diferent parts of OpenZeppelin, as well as [documentation for the API][API docs]. Keep in mind that the API docs are work in progress, and don’t hesitate to ask questions in [our Slack][Slack]. | ||
|
|
||
| ## Security | ||
|
|
||
| OpenZeppelin the project is maintained by [Zeppelin] the company, and developed following our high standards for code quality and security. OpenZeppelin is meant to provide 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 problems you might experience. | ||
|
|
||
| The core development principles and strategies that OpenZeppelin is based on include: security in depth, simple and modular code, clarity-driven naming conventions, comprehensive unit testing, pre-and-post-condition sanity checks, code consistency, and regular audits. | ||
|
|
||
| Please report any security issues you find to security@openzeppelin.org. | ||
|
|
||
| ## Contribute | ||
|
|
||
| OpenZeppelin exists thanks to its contributors. There are many ways you can participate and help build high quality software. Check out the [contribution guide]! | ||
| - StandaloneERC20 | ||
| - StandaloneERC721 | ||
| - TokenVesting | ||
| - PaymentSplitter | ||
|
|
||
| ## License | ||
|
|
||
| OpenZeppelin is released under the [MIT License](LICENSE). | ||
|
|
||
|
|
||
| [API docs]: https://openzeppelin.org/api/docs/token_ERC721_ERC721BasicToken.html | ||
| [guides]: https://openzeppelin.org/api/docs/get-started.html | ||
| [Slack]: https://slack.openzeppelin.org | ||
| [Zeppelin]: https://zeppelin.solutions | ||
| [contribution guide]: CONTRIBUTING.md | ||
| [Truffle]: https://truffleframework.com/docs/truffle/quickstart | ||
| [Embark]: https://embark.status.im/docs/quick_start.html |