From 52a6d2d3a5afeff26be906b09ba18405c116dbaf Mon Sep 17 00:00:00 2001 From: ernestognw Date: Wed, 29 May 2024 14:58:35 -0600 Subject: [PATCH] README nits --- README.md | 20 ++++++++++++-------- package.json | 2 +- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a0dacf4f..90c73338 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,20 @@ [![Forum](https://img.shields.io/badge/forum-%F0%9F%92%AC-yellow)](https://docs.openzeppelin.com/contracts) +> [!IMPORTANT] +> This repository includes experimental code that has not been audited and may introduce breaking changes at any time. We recommend +> reviewing the [Security](#security) section before using any code from this repository. + ## Overview -This repository contains contracts and libraries in the following catogories: +This repository contains contracts and libraries in the following categories: -- extensions and modules compatible with contracts in the [@openzeppelin/contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) package; -- alternative implementation of interfaces defined in the [@openzeppelin/contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) package; -- building blocks for developers; -- prototypes in general. +- Extensions and modules compatible with contracts in the [@openzeppelin/contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) package +- Alternative implementation of interfaces defined in the [@openzeppelin/contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) package +- Contracts with third-party integrations +- General prototypes and experiments -Code is provided by the openzeppelin solidity team, as well as by community contributors, for other developers to review, discuss, iterate on, and potentially use (see [the Security section](#security) before you do). +Code is provided by the OpenZeppelin Contracts team, as well as by community contributors, for other developers to review, discuss, iterate on, and potentially use. ## Security @@ -25,9 +29,9 @@ Contracts and libraries in this repository are provided as is, with no particula - Code in this repository may depend on un-audited and un-released features from the [OpenZeppelin Contracts repository](https://github.com/OpenZeppelin/openzeppelin-contracts). In some cases, having a versioned dependency on the OpenZeppelin contracts library may not be enough. -- Code in this repository is not versioned or formally released. +- Code in this repository is not versioned nor formally released. -- Bug affecting code in this repository may not be notified through a CVE. +- Bugs affecting code in this repository may not be notified through a CVE. ## Contribute diff --git a/package.json b/package.json index 978a5df5..1cddf635 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@openzeppelin/contracts-experimental", "version": "0.0.1", - "description": "Secure Smart Contract library for Solidity", + "description": "Experimental Smart Contract library for Solidity", "author": "OpenZeppelin Community ", "license": "MIT", "files": [