Skip to content

Commit

Permalink
Add wizard to README (#1267)
Browse files Browse the repository at this point in the history
* feat: add wizard to README

* fix: README

* feat: update NOTE and WARNING
  • Loading branch information
ericnordelo authored Dec 18, 2024
1 parent e28b987 commit 8a4f091
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@

**A library for secure smart contract development** written in Cairo for [Starknet](https://starkware.co/product/starknet/), a decentralized ZK Rollup.

> **Warning**
> This repo contains highly experimental code.
> It has no code coverage checks.
> It hasn't been audited.
> **Use at your own risk.**
> [!TIP]
> :mage: **Not sure how to get started?** Check out [Contracts Wizard for Cairo](https://wizard.openzeppelin.com/cairo) — an interactive smart contract generator.
## Usage

> **Warning**
> Expect rapid iteration.
> [!WARNING]
> This repo contains highly experimental code.
> It hasn't been audited.
> **Use at your own risk.**
### Prepare the environment

Expand Down Expand Up @@ -127,7 +126,8 @@ Check out the [full documentation site](https://docs.openzeppelin.com/contracts-

## Development

> **Note**: You can track our roadmap and future milestones in our [Github Project](https://github.com/orgs/OpenZeppelin/projects/29/).
> [!NOTE]
> You can track our roadmap and future milestones in our [Github Project](https://github.com/orgs/OpenZeppelin/projects/29/).
OpenZeppelin Contracts for Cairo exists thanks to its contributors. There are many ways you can participate and help build high quality software, make sure to check out the [contribution](CONTRIBUTING.md) guide in advance.

Expand All @@ -154,7 +154,7 @@ snforge test -w

## Security

> ⚠️ Warning! ⚠️
> [!WARNING]
> This project is still in a very early and experimental phase. It has never been audited nor thoroughly reviewed for security vulnerabilities. Do not use in production.
Refer to [SECURITY.md](SECURITY.md) for more details.
Expand Down

0 comments on commit 8a4f091

Please sign in to comment.