Skip to content

Commit

Permalink
chore(readme): add Telegram link and additional information for contr…
Browse files Browse the repository at this point in the history
…ibuting (#38)

* add additional sections and telegram link

* clean up

* clean up
  • Loading branch information
zerosnacks authored Mar 28, 2024
1 parent 0b6148f commit ed1b186
Showing 1 changed file with 34 additions and 4 deletions.
38 changes: 34 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
# 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 <Example>`:

```sh
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)
Expand Down Expand Up @@ -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

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br>

<sub>
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.
</sub>

0 comments on commit ed1b186

Please sign in to comment.