Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add wizard to README #1267

Merged
merged 3 commits into from
Dec 18, 2024
Merged

Add wizard to README #1267

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f9b7ba5
feat: add wizard to README
ericnordelo Dec 18, 2024
6a59402
fix: README
ericnordelo Dec 18, 2024
3f53d9d
feat: update NOTE and WARNING
ericnordelo Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
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
Loading