Forráskód Böngészése

Rebrand readme (#1832)

* update readme with new branding

* update readme text with new branding and links

* add newer link to api stability document
Francisco Giordano 6 éve
szülő
commit
eae306f259
2 módosított fájl, 10 hozzáadás és 9 törlés
  1. 10 9
      README.md
  2. BIN
      logo.png

+ 10 - 9
README.md

@@ -1,10 +1,10 @@
-# <img src="logo.png" alt="OpenZeppelin" width="400px">
+# <img src="logo.png" alt="OpenZeppelin" height="40px">
 
-[![NPM Package](https://img.shields.io/npm/v/openzeppelin-solidity.svg?style=flat-square)](https://www.npmjs.org/package/openzeppelin-solidity)
+[![NPM Package](https://img.shields.io/npm/v/openzeppelin-solidity.svg)](https://www.npmjs.org/package/openzeppelin-solidity)
 [![Build Status](https://travis-ci.com/OpenZeppelin/openzeppelin-solidity.svg?branch=master)](https://travis-ci.com/OpenZeppelin/openzeppelin-solidity)
 [![Coverage Status](https://coveralls.io/repos/github/OpenZeppelin/openzeppelin-solidity/badge.svg?branch=master)](https://coveralls.io/github/OpenZeppelin/openzeppelin-solidity?branch=master)
 
-**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.
+**OpenZeppelin Contracts 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.
 
 ## Install
 
@@ -12,7 +12,7 @@
 npm install openzeppelin-solidity
 ```
 
-OpenZeppelin features a stable API, which means your contracts won't break unexpectedly when upgrading to a newer minor version. You can read ṫhe details in our [API Stability](https://forum.zeppelin.solutions/t/api-stability/138) document.
+OpenZeppelin Contracts features a stable API, which means your contracts won't break unexpectedly when upgrading to a newer minor version. You can read ṫhe details in our [API Stability] document.
 
 ## Usage
 
@@ -36,7 +36,7 @@ On our site you will find a few [guides] to learn about the different parts of O
 
 ## 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.
+This project is maintained by [OpenZeppelin], 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.
 
@@ -53,10 +53,11 @@ OpenZeppelin exists thanks to its contributors. There are many ways you can part
 OpenZeppelin is released under the [MIT License](LICENSE).
 
 
-[API docs]: https://docs.openzeppelin.org/v2.3.0/api/token/erc721
-[guides]: https://docs.openzeppelin.org/v2.3.0/get-started
-[forum]: https://forum.zeppelin.solutions
-[Zeppelin]: https://zeppelin.solutions
+[API docs]: https://docs.openzeppelin.com/contracts/api/token/erc20
+[guides]: https://docs.openzeppelin.com/contracts
+[API Stability]: https://docs.openzeppelin.com/contracts/api-stability
+[forum]: https://forum.openzeppelin.com
+[OpenZeppelin]: https://openzeppelin.com
 [contribution guide]: CONTRIBUTING.md
 [Truffle]: https://truffleframework.com/docs/truffle/quickstart
 [Embark]: https://embark.status.im/docs/quick_start.html

BIN
logo.png