diff --git a/README.md b/README.md index 302d8d99..165c01a9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,14 @@ # Alloy Examples -Example code using [alloy](https://github.com/alloy-rs/alloy) and [alloy-core](https://github.com/alloy-rs/core). +These examples demonstrate the main features of [alloy](https://github.com/alloy-rs/alloy) and [alloy-core](https://github.com/alloy-rs/core) as well as how to use them. -These examples demonstrate the main features of [Alloy](https://github.com/alloy-rs/alloy) and how to use them. +[![Telegram chat][telegram-badge]][telegram-url] + +[`ethers-rs`]: https://github.com/gakonst/ethers-rs +[telegram-badge]: https://img.shields.io/endpoint?color=neon&style=for-the-badge&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Fethers_rs +[telegram-url]: https://t.me/ethers_rs + +## Usage To run an example, use the command `cargo run --example `: @@ -10,9 +16,9 @@ To run an example, use the command `cargo run --example `: cargo run --example mnemonic_signer ``` ---- +## Overview -## Table of Contents +This repository contains the following examples: - [x] Anvil - [x] [Deploy contract](./examples/anvil/examples/deploy_contract_anvil.rs) @@ -67,3 +73,27 @@ cargo run --example mnemonic_signer - [x] [Yubi signer](./examples/wallets/examples/yubi_signer.rs) - [x] [Keystore signer](./examples/wallets/examples/keystore_signer.rs) - [x] [Create keystore](./examples/wallets/examples/create_keystore.rs) + +## Contributing + +Thanks for your help improving the project! We are so happy to have you! We have +[a contributing guide](./CONTRIBUTING.md) to help you get involved in the +Alloy project. + +Pull requests will not be merged unless CI passes, so please ensure that your +contribution follows the linting rules and passes clippy. + +#### License + + +Licensed under either of Apache License, Version +2.0 or MIT license at your option. + + +
+ + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in these crates by you, as defined in the Apache-2.0 license, +shall be dual licensed as above, without any additional terms or conditions. + \ No newline at end of file