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.

Sign up for GitHub

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

chore: Readme Cleanup #107

Merged
merged 1 commit into from
Oct 24, 2024
Merged

chore: Readme Cleanup #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Binary file added .assets/banner.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 37 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,44 @@
# op-rs
<h1 align="center">
<img src="./.assets/banner.png" alt="op-rs" width="100%" align="center">
</h1>

<!-- [![Crates.io][crates-badge]][crates-io] -->
<!-- [![Downloads][downloads-badge]][crates-io] -->
[![MIT License][mit-badge]][mit-url]
[![Apache-2.0 License][apache-badge]][apache-url]
[![CI Status][actions-badge]][actions-url]
<h4 align="center">
A suite of `std` components for OP Stack L2 chain derivation, batch submission, and periphery services.
</h4>

<!-- ### Security -->
<p align="center">
<a href="https://github.com/ithacaxyz/op-rs/actions?query=workflow%3ACI+branch%3Amain"><img src="https://github.com/ithacaxyz/op-rs/workflows/unit/badge.svg" alt="License"></a>
<img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License">
<img src="https://img.shields.io/badge/License-Apache%202.0-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License">
<a href="https://img.shields.io/codecov/c/github/ithacaxyz/op-rs"><img src="https://img.shields.io/codecov/c/github/ithacaxyz/op-rs" alt="Codecov"></a>
<!-- <a href="https://crates.io/crates/rope"><img src="https://img.shields.io/crates/v/op-rs.svg" alt="Crates.io"></a> -->
<!-- <a href="https://crates.io/crates/rope"><img src="https://img.shields.io/crates/d/op-rs.svg" alt="Downloads"></a> -->
</p>

<!-- See [SECURITY.md](SECURITY.md). -->
<p align="center">
<a href="#overview">Overview</a> •
<a href="#security">Security</a> •
<a href="#contributing">Contributing</a> •
<a href="#license">License</a>
</p>

#### 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

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
Expand All @@ -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.
</sub>

<!-- [crates-badge]: https://img.shields.io/crates/v/op-rs.svg -->
<!-- [crates-io]: https://crates.io/crates/op-rs -->
<!-- [downloads-badge]: https://img.shields.io/crates/d/op-rs -->
[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