Skip to content

Commit 52a6d2d

Browse files
committed
README nits
1 parent d4d0162 commit 52a6d2d

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,20 @@
22

33
[![Forum](https://img.shields.io/badge/forum-%F0%9F%92%AC-yellow)](https://docs.openzeppelin.com/contracts)
44

5+
> [!IMPORTANT]
6+
> This repository includes experimental code that has not been audited and may introduce breaking changes at any time. We recommend
7+
> reviewing the [Security](#security) section before using any code from this repository.
8+
59
## Overview
610

7-
This repository contains contracts and libraries in the following catogories:
11+
This repository contains contracts and libraries in the following categories:
812

9-
- extensions and modules compatible with contracts in the [@openzeppelin/contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) package;
10-
- alternative implementation of interfaces defined in the [@openzeppelin/contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) package;
11-
- building blocks for developers;
12-
- prototypes in general.
13+
- Extensions and modules compatible with contracts in the [@openzeppelin/contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) package
14+
- Alternative implementation of interfaces defined in the [@openzeppelin/contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) package
15+
- Contracts with third-party integrations
16+
- General prototypes and experiments
1317

14-
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).
18+
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.
1519

1620
## Security
1721

@@ -25,9 +29,9 @@ Contracts and libraries in this repository are provided as is, with no particula
2529

2630
- 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.
2731

28-
- Code in this repository is not versioned or formally released.
32+
- Code in this repository is not versioned nor formally released.
2933

30-
- Bug affecting code in this repository may not be notified through a CVE.
34+
- Bugs affecting code in this repository may not be notified through a CVE.
3135

3236
## Contribute
3337

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@openzeppelin/contracts-experimental",
33
"version": "0.0.1",
4-
"description": "Secure Smart Contract library for Solidity",
4+
"description": "Experimental Smart Contract library for Solidity",
55
"author": "OpenZeppelin Community <[email protected]>",
66
"license": "MIT",
77
"files": [

0 commit comments

Comments
 (0)