From bb571ed98a1ddf23f7808482d56e625998eb8251 Mon Sep 17 00:00:00 2001 From: Demian Brener Date: Wed, 14 Sep 2016 12:30:25 -0300 Subject: [PATCH] Update README --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cd6de937e..652457b01 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# zeppelin-solidity -Secure Smart Contract library for the Solidity language +# Zeppelin Solidity +Zeppelin is a secure Smart Contract library for the Solidity language. Provides contracts to help with easy implementation of common security patterns. See [Onward with Ethereum Smart Contract Security](https://medium.com/bitcorps-blog/onward-with-ethereum-smart-contract-security-97a827e47702#.y3kvdetbz). -## Getting started +## Getting Started Zeppelin integrates with [Truffle](https://github.com/ConsenSys/truffle), an Ethereum development environment. Please [install Truffle](https://github.com/ConsenSys/truffle#install) and initialize your project with `truffle init`. ```sh @@ -27,5 +27,25 @@ contract MetaCoin is Rejector { } ``` +## 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. + +If you find a security issue, please email [security@openzeppelin.org](mailto:security@openzeppelin.org). + +## Developer Resources + +Building a distributed application, protocol or organization with Zeppelin? + +- Ask for help and follow progress at: https://zeppelin-slackin.herokuapp.com/ + +Interested in contributing to Zeppelin? + +- Framework proposal and roadmap: +- Issue tracker: https://github.com/OpenZeppelin/zep-solidity/issues +- Contribution guidelines: https://github.com/OpenZeppelin/zep-solidity/blob/master/CONTRIBUTING.md + ## Contracts TODO + +## License +Code released under the [MIT License](https://github.com/OpenZeppelin/zep-solidity/blob/master/LICENSE).