Skip to content

Commit

Permalink
++
Browse files Browse the repository at this point in the history
  • Loading branch information
qalisander committed Sep 24, 2024
1 parent ab94e83 commit bb318a1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,25 @@
- [Unit] and [integration] test affordances, used in our own tests.

[`openzeppelin-contracts`]: https://github.com/OpenZeppelin/openzeppelin-contracts

[`koba`]: https://github.com/OpenZeppelin/koba

[Unit]: ./lib/motsu/README.md

[integration]: ./lib/e2e/README.md

## Usage

You can import OpenZeppelin Contracts from crates.io by adding the following line to your `Cargo.toml` (We recommend pinning to a specific version):
You can import OpenZeppelin Contracts from crates.io by adding the following
line to your `Cargo.toml` (We recommend pinning to a specific version):

```toml
[dependencies]
openzeppelin-stylus = "0.1.0-rc"
```

Optionally,you can specify a git dependency if you want to have the latest changes from the `main` branch:
Optionally, you can specify a git dependency if you want to have the latest
changes from the `main` branch:

```toml
[dependencies]
Expand All @@ -53,7 +58,7 @@ sol_storage! {

#[external]
#[inherit(Erc20)]
impl Erc20Example { }
impl Erc20Example {}
```

For a more complex display of what this library offers, refer to our
Expand All @@ -66,11 +71,12 @@ For more information on what this library will include in the future, see our
[roadmap].

[basic]: ./examples/basic

[roadmap]: https://github.com/OpenZeppelin/rust-contracts-stylus/milestone/1

## Contribute

OpenZeppelin Contracts for Stylus exists thanks to its contributors. There are
OpenZeppelin Contracts for Stylus exist thanks to its contributors. There are
many ways you can participate and help build high-quality software. Check out
the [contribution guide](CONTRIBUTING.md)!

Expand All @@ -85,4 +91,5 @@ Refer to our [Security Policy](SECURITY.md) for more details.

## License

OpenZeppelin Contracts for Stylus is released under the [MIT License](./LICENSE).
OpenZeppelin Contracts for Stylus is released under
the [MIT License](./LICENSE).
1 change: 0 additions & 1 deletion lib/motsu-proc/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ alloy-primitives.workspace = true
alloy-sol-types.workspace = true
stylus-sdk.workspace = true


[lib]
proc-macro = true

Expand Down

0 comments on commit bb318a1

Please sign in to comment.