Skip to content

Commit f628475

Browse files
committed
Added 2 README.md
1 parent 11f13a7 commit f628475

File tree

2 files changed

+39
-3
lines changed

2 files changed

+39
-3
lines changed

README.md

+39-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,39 @@
1-
openzeppelin-rs/README.md
1+
# openzeppelin-rs
2+
3+
> The library is actually located in the openzeppelin-rs folder.
4+
5+
## Quickstart
6+
7+
> This library depends on `ethers-rs`. If you haven't already added it to your project you can do it with `cargo add ethers`.
8+
9+
Add `openzeppelin-rs` to your project:
10+
11+
```
12+
cargo add openzeppelin-rs
13+
```
14+
15+
And add this to your code:
16+
17+
```
18+
use openzeppelin_rs::*;
19+
```
20+
21+
You are good to go !
22+
23+
## Exemple
24+
25+
```rust
26+
use ethers::types::Address;
27+
use openzeppelin_rs::*;
28+
29+
#[tokio::main]
30+
async fn main() -> Result<(), Box<dyn std::error::Error>> {
31+
32+
let address: Address = WETH_ADDRESS.parse()?;
33+
let contract = ERC20::new(address, **yourProvider**);
34+
35+
println!("{}", contract.symbol().await?);
36+
37+
Ok(())
38+
}
39+
```

openzeppelin-rs/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# openzeppelin-rs
22

3-
> The library is actually located in the openzeppelin-rs folder.
4-
53
## Quickstart
64

75
> This library depends on `ethers-rs`. If you haven't already added it to your project you can do it with `cargo add ethers`.

0 commit comments

Comments
 (0)