diff --git a/.assets/banner.png b/.assets/banner.png new file mode 100644 index 0000000..decb9fc Binary files /dev/null and b/.assets/banner.png differ diff --git a/README.md b/README.md index a0a71f2..784503a 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,44 @@ -# op-rs +

+ op-rs +

- - -[![MIT License][mit-badge]][mit-url] -[![Apache-2.0 License][apache-badge]][apache-url] -[![CI Status][actions-badge]][actions-url] +

+ A suite of `std` components for OP Stack L2 chain derivation, batch submission, and periphery services. +

- +

+ License + License + License + Codecov + + +

- +

+ Overview • + Security • + Contributing • + License +

-#### License +## Overview + +_**op**timism-**r**ust_ + +`op-rs` is a suite of portable, modular `std` OP Stack components. + +[bin/](./bin/) provides a host of binary applications that compose [crates](./crates/). + +## Security + +Specifications around security are provided in [Security.md](./Security.md). + +## Contributing + +Contributing guidelines are outlined in [Contributing.md](./Contributing.md). + +## License Licensed under either of Apache License, Version @@ -25,12 +53,5 @@ 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. - - - -[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg -[apache-badge]: https://img.shields.io/badge/license-Apache--2.0-blue.svg [mit-url]: LICENSE-MIT [apache-url]: LICENSE-APACHE -[actions-badge]: https://github.com/ithacaxyz/op-rs/workflows/unit/badge.svg -[actions-url]: https://github.com/ithacaxyz/op-rs/actions?query=workflow%3ACI+branch%3Amain