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.

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

docs: update README.md #208

Merged
merged 1 commit into from
Jul 26, 2023
Merged
Changes from all commits
Commits
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
31 changes: 19 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@

Core libraries at the root of the Rust Ethereum ecosystem.

Alloy is a rewrite of ethers-rs from the ground up, with exciting new features,
high performance & excellent docs.
Ethers-rs will continue to be maintained until we have feature-parity in Alloy.
No action is needed from devs.
Alloy is a rewrite of [`ethers-rs`] from the ground up, with exciting new
features, high performance, and excellent docs.

[`ethers-rs`] will continue to be maintained until we have achieved
feature-parity in Alloy. No action is currently needed from devs.

[`ethers-rs`]: https://github.com/gakonst/ethers-rs

[![Build Status][actions-badge]][actions-url]
[![Telegram chat][telegram-badge]][telegram-url]
Expand All @@ -20,21 +23,25 @@ No action is needed from devs.
This repository contains the following crates:

- [`alloy-primitives`] - Primitive integer and byte types
- [`alloy-sol-type-parser`] - A simple parser for Solidity type strings
- [`alloy-sol-types`] - Compile-time [ABI] and [EIP-712] implementations
- [`alloy-sol-macro`] - The [`sol!`] procedural macro
- [`alloy-dyn-abi`] - Run-time [ABI] and [EIP-712] implementations
- [`alloy-json-abi`] - [JSON-ABI] implementation
- [`alloy-dyn-abi`] - Run-time ABI and [EIP-712] implementations
- [`alloy-sol-types`] - Compile-time ABI and [EIP-712] implementations
- [`alloy-sol-macro`] - The `sol!` procedural macro
- [`syn-solidity`] - [`syn`]-powered Solidity parser, used by `alloy-sol-macro`
- [`alloy-sol-type-parser`] - A simple parser for Solidity type strings
- [`syn-solidity`] - [`syn`]-powered Solidity parser

[`alloy-primitives`]: ./crates/primitives
[`alloy-json-abi`]: ./crates/json-abi
[`alloy-sol-type-parser`]: ./crates/sol-type-parser
[`alloy-dyn-abi`]: ./crates/dyn-abi
[`alloy-sol-types`]: ./crates/sol-types
[`alloy-sol-macro`]: ./crates/sol-macro
[`alloy-dyn-abi`]: ./crates/dyn-abi
[`alloy-json-abi`]: ./crates/json-abi
[`alloy-sol-type-parser`]: ./crates/sol-type-parser
[`syn-solidity`]: ./crates/syn-solidity

[JSON-ABI]: https://docs.soliditylang.org/en/latest/abi-spec.html#json
[ABI]: https://docs.soliditylang.org/en/latest/abi-spec.html
[EIP-712]: https://eips.ethereum.org/EIPS/eip-712
[`sol!`]: https://docs.rs/alloy-sol-macro/latest/alloy_sol_macro/macro.sol.html
[`syn`]: https://github.com/dtolnay/syn

## Supported Rust Versions
Expand Down