Skip to content

Commit

Permalink
docs: update some READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
DaniPopes committed Jun 4, 2024
1 parent 7f17fe3 commit 7d74d6b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
14 changes: 12 additions & 2 deletions crates/sol-macro-expander/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# alloy-sol-macro-expander

This crate contains the expansion logic for a Solidity proc_macro2::TokenStream.
This crate contains the expansion logic for a Solidity `proc_macro2::TokenStream`.
It's used to expand and generate Rust bindings from Solidity.

It helps convert Solidity tokens to their respective Rust bindings.
Note: This is not the procedural macro crate, it is intended to be used as library crate.

This crate is used by [`sol!`] macro in the [`alloy-sol-macro`] crate.

> [!WARNING]
> This crate does not have a stable API, and all exposed functions are subject to change.
> We reserve the right to make any breaking changes to this crate without notice.
[`sol!`]: https://docs.rs/alloy-sol-macro/latest/alloy_sol_macro/macro.sol.html
[`alloy-sol-macro`]: https://crates.io/alloy-sol-macro/
2 changes: 0 additions & 2 deletions crates/syn-solidity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
The parsed root element is the [`File`], which contains a list of [`Item`]s.
[`Item`]s also support outer attributes, as shown below.

**⚠️ Work in progress ⚠️**

[`syn`]: https://github.com/dtolnay/syn
[`TokenStream`]: https://doc.rust-lang.org/proc_macro/struct.TokenStream.html

Expand Down

0 comments on commit 7d74d6b

Please sign in to comment.