Skip to content
Merged
Show file tree
Hide file tree
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
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<a href="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml"><img src="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a>
<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
<a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Contributor%20Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
<a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>

Built on [Alloy][alloy], op-alloy connects applications to the OP Stack.

Expand All @@ -22,6 +22,10 @@ The following crates are provided by `op-alloy`.
- [`op-alloy-rpc-types`][op-alloy-rpc-types]


## Development Status

`op-alloy` is currently in active development, and is not yet ready for use in production.

## Supported Rust Versions (MSRV)

The current MSRV (minimum supported rust version) is 1.81.
Expand All @@ -37,7 +41,7 @@ only as part of a patch (pre-1.0) or minor (post-1.0) release.

op-alloy is built by open source contributors like you, thank you for improving the project!

A [contributing guide][contributing] is available to help you get started to contribute to op-alloy.
A [contributing guide][contributing] is available that sets guidelines for contributing.

Pull requests will not be merged unless CI passes, so please ensure that your contribution follows the
linting rules and passes clippy.
Expand All @@ -64,7 +68,7 @@ please make sure to update [scripts/check_no_std.sh][check-no-std].

op-alloy is inspired by the work of several teams and projects, most notably [the Alloy project][alloy].

op-alloy would not be possible without the contributions from open source contributors. Thank you.
This would not be possible without the hard work from open source contributors. Thank you.


## License
Expand All @@ -78,15 +82,14 @@ 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>


<!-- Hyperlinks -->

[check-no-std]: ./scripts/check_no_std.sh

[contributing]: https://alloy-rs.github.io/op-alloy

[kona]: https://github.com/anton-rs/kona

[alloy]: https://github.com/alloy-rs/alloy
[contributing]: https://alloy-rs.github.io/op-alloy

[op-alloy-consensus]: https://crates.io/crates/op-alloy-consensus
[op-alloy-genesis]: https://crates.io/crates/op-alloy-genesis
Expand Down
2 changes: 1 addition & 1 deletion book/src/intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# op-alloy Book

<a href="https://github.com/alloy-rs/op-alloy"><img src="https://img.shields.io/badge/GitHub%20Repo-op-alloy-green?logo=github"></a>
<a href="https://github.com/alloy-rs/op-alloy"><img src="https://img.shields.io/github/stars/alloy-rs/op-alloy"></a>

Welcome to the hands-on guide for getting started with op-alloy!

Expand Down
2 changes: 2 additions & 0 deletions book/src/links.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- op-alloy -->

[check-no-std]: https://github.com/alloy-rs/op-alloy/blob/main/scripts/check_no_std.sh
[contributing]: https://alloy-rs.github.io/op-alloy
[op-alloy-crate]: https://crates.io/crates/op-alloy

[op-alloy-consensus]: https://crates.io/crates/op-alloy-consensus
Expand Down