Skip to content

Commit

Permalink
Update README to link docs and update install instructions (#180)
Browse files Browse the repository at this point in the history
When working with this repository, I didn't realize that there is a
crates.io distribution or that there are any docs. I am updating the
README in hopes of helping others in the future.
  • Loading branch information
wilsoncusack authored Jul 30, 2024
1 parent 7b8c5e9 commit cb32f7f
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Foundry Compilers
| [Docs](https://docs.rs/foundry-compilers/latest/foundry_compilers/) |

Originally part of [`ethers-rs`] as `ethers-solc`, Foundry Compilers is the compilation backend for [Foundry](https://github.com/foundry-rs/foundry).

Expand Down Expand Up @@ -45,7 +46,7 @@ To install, simply add `foundry-compilers` to your cargo dependencies.

```toml
[dependencies]
foundry-compilers = { git = "https://github.com/foundry-rs/compilers" }
foundry-compilers = "0.10.1"
```

Example usage:
Expand Down

0 comments on commit cb32f7f

Please sign in to comment.