Skip to content

Commit

Permalink
fix: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
refcell committed Aug 27, 2024
1 parent 5800b2e commit 35b6192
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 3 deletions.
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,29 @@
# `superchain`
<h1 align="center">
<img src="./assets/banner.png" alt="Superchain" width="100%" align="center">
</h1>

Rust Bindings for the [superchain-registry][sr].
<h4 align="center">
Rust bindings for the <a href="https://github.com/ethereum-optimism/superchain-registry">superchain-registry</a>.
</h4>

<p align="center">
<a href="https://github.com/anton-rs/superchain/actions/workflows/rust_ci.yaml"><img src="https://github.com/anton-rs/superchain/actions/workflows/rust_ci.yaml/badge.svg?label=ci" alt="CI"></a>
<img src="https://img.shields.io/badge/License-MIT-green.svg?label=license&labelColor=2a2f35" alt="License">
<a href="https://github.com/ethereum-optimism/monorepo"><img src="https://img.shields.io/badge/OP%20Stack-monorepo-red?labelColor=2a2f35" alt="OP Stack"></a>
</p>

<p align="center">
<a href="#whats-superchain">What's Superchain?</a> •
<a href="#usage">Usage</a> •
<a href="#example">Example</a> •
<a href="#credits">Credits</a>
</p>

## What's Superchain?

The [Superchain](https://docs.optimism.io/stack/explainer) is a network of chains that share bridging, decentralized governance, upgrades, a communication layer and more.

This repository contains rust bindings for the [superchain-registry][sr].

The best way to work with this repo is through the [`superchain`][sup]
crate. [`superchain`][sup] is an optionally `no_std` crate that provides
Expand Down Expand Up @@ -60,6 +83,10 @@ println!("OP Mainnet Chain Config: {:?}", op_chain_config);
- `serde`: Enables [`serde`][s] support for types and makes [`superchain-registry`][scr] types available.
- `std`: Uses the standard library to pull in environment variables.

## Credits

This repository could not be built without OP Labs contributors working on the [superchain-registry][scr] and [alloy-rs](https://github.com/alloy-rs) contributors.

<!-- Hyperlinks -->

[sp]: ./crates/superchain-primitives
Expand All @@ -70,4 +97,3 @@ println!("OP Mainnet Chain Config: {:?}", op_chain_config);
[sup]: https://crates.io/crates/superchain
[scp]: https://crates.io/crates/superchain-primitives
[superchain]: https://github.com/anton-rs/superchain

Empty file added assets/.gitkeep
Empty file.

0 comments on commit 35b6192

Please sign in to comment.