From 35b6192c3eb8022bd8e81b77f06878ae3fe92715 Mon Sep 17 00:00:00 2001 From: refcell Date: Tue, 27 Aug 2024 18:51:24 -0400 Subject: [PATCH] fix: readme --- README.md | 32 +++++++++++++++++++++++++++++--- assets/.gitkeep | 0 2 files changed, 29 insertions(+), 3 deletions(-) create mode 100644 assets/.gitkeep diff --git a/README.md b/README.md index 190a5fe..35c941b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,29 @@ -# `superchain` +

+ Superchain +

-Rust Bindings for the [superchain-registry][sr]. +

+ Rust bindings for the superchain-registry. +

+ +

+ CI + License + OP Stack +

+ +

+ What's Superchain? • + Usage • + Example • + Credits +

+ +## 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 @@ -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. + [sp]: ./crates/superchain-primitives @@ -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 - diff --git a/assets/.gitkeep b/assets/.gitkeep new file mode 100644 index 0000000..e69de29