diff --git a/README.md b/README.md index 2bc760123..c062cc9ce 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ License Book -Transports, Middleware, and Networks for Optimism built with [Alloy][alloy]. +Built on [Alloy][alloy], op-alloy connects applications to the OP Stack. ## Usage @@ -50,12 +50,11 @@ op-alloy is intended to be `no_std` compatible, initially for use in [kona][kona The following crates support `no_std`. Notice, provider crates do not support `no_std` compatibility. -- `op-alloy-consensus` -- `op-alloy-genesis` -- `op-alloy-protocol` -- `op-alloy-genesis` -- `op-alloy-rpc-types` -- `op-alloy-rpc-types-engine` +- [`op-alloy-consensus`][op-alloy-consensus] +- [`op-alloy-genesis`][op-alloy-genesis] +- [`op-alloy-protocol`][op-alloy-protocol] +- [`op-alloy-rpc-types-engine`][op-alloy-rpc-types-engine] +- [`op-alloy-rpc-types`][op-alloy-rpc-types] If you would like to add no_std support to a crate, please make sure to update [scripts/check_no_std.sh][check-no-std]. diff --git a/book/src/CONTRIBUTING.md b/book/src/CONTRIBUTING.md index 343dc1481..48c6cbf4b 100644 --- a/book/src/CONTRIBUTING.md +++ b/book/src/CONTRIBUTING.md @@ -7,10 +7,8 @@ discuss the change you wish to make via issue. Before working with this repository locally, you'll need to install several dependencies: -- [Docker](https://www.docker.com/) for cross-compilation. -- [just](https://github.com/casey/just) for our command-runner scripts. -- The [Rust toolchain](https://rustup.rs/) -- The [Golang toolchain](https://go.dev/dl/) +- [Just](https://github.com/casey/just) for our command-runner scripts. +- [The Rust toolchain](https://rustup.rs/). **Optional** diff --git a/book/src/LICENSE.md b/book/src/LICENSE.md new file mode 100644 index 000000000..414b0e98a --- /dev/null +++ b/book/src/LICENSE.md @@ -0,0 +1,10 @@ +# Licensing + +op-alloy is dually licensed under the [Apache 2.0][apache] and the [MIT][mit] license. + +The [SNAPPY license][snappy] is added for the use of [snap][snap] in `op-alloy-rpc-types-engine`. + +[snap]: https://github.com/BurntSushi/rust-snappy +[snappy]: https://github.com/alloy-rs/op-alloy/blob/main/SNAPPY-LICENSE +[apache]: https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE +[mit]: https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT diff --git a/book/src/building/rollup-configs.md b/book/src/building/rollup-configs.md new file mode 100644 index 000000000..7a4cfbb6e --- /dev/null +++ b/book/src/building/rollup-configs.md @@ -0,0 +1,3 @@ +# Rollup Configs + + diff --git a/book/src/examples/genesis/loading-a-rollup-config.md b/book/src/examples/genesis/loading-a-rollup-config.md new file mode 100644 index 000000000..e69de29bb diff --git a/book/src/intro.md b/book/src/intro.md index 3a6385f55..c150e4d92 100644 --- a/book/src/intro.md +++ b/book/src/intro.md @@ -1,27 +1,45 @@ # op-alloy Book -_Documentation for op-alloy._ - -> 📖 `op-alloy` is in active development, and is not yet ready for use in production. During development, this book will evolve quickly and may contain inaccuracies. +Welcome to the hands-on guide for getting started with op-alloy! + +op-alloy connects applications to the OP Stack, leveraging high +performance types, traits, and middleware from [alloy][alloy]. + +> 📖 Development Status > -> Please [open an issue][new-issue] if you find any errors or have any suggestions for improvements, and also feel free to [contribute][contributing] to the project! +> `op-alloy` is in active development, and is not yet ready for use in production. +> During development, this book will evolve quickly and may contain inaccuracies. +> +> Please [open an issue][new-issue] if you find any errors or have any suggestions for +> improvements, and also feel free to [contribute][contributing] to the project! -## Introduction +## Sections -op-alloy is a collection of types, middleware, and networks for Optimism built on top of [alloy][alloy]. +### [Getting Started](./starting/installation.md) -It is built and maintained by Alloy contributors, members of [OP Labs][op-labs], and the broader -open source community. op-alloy is licensed under the combined Apache 2.0 and MIT License, along -with a SNAPPY license for snappy encoding use. +To get started with op-alloy, add op-alloy crates as a dependency and take your first steps. + +### [Building with op-alloy](./building/rollup-configs.md) -## Development Status +A walkthrough of building with op-alloy. -**op-alloy is currently in active development, and is not yet ready for use in production.** +### [Examples](./examples/genesis/loading-a-rollup-config.md) -## Contributing +This section will give you practical examples of how Alloy can be used in your codebase. + +### [Contributing](./CONTRIBUTING.md) + +Contributors are welcome! It is built and maintained by Alloy contributors, +members of [OP Labs][op-labs], and the broader open source community. + +Please see the [contributing guide][contributing] to get involved. + +### [Licensing](./LICENSE.md) + +op-alloy is licensed under the combined Apache 2.0 and MIT License, along +with a SNAPPY license for snappy encoding use. -Contributors are welcome! Please see the [contributing guide][contributing] for more information. {{#include ./links.md}} diff --git a/book/src/starting/installation.md b/book/src/starting/installation.md new file mode 100644 index 000000000..11f82b92b --- /dev/null +++ b/book/src/starting/installation.md @@ -0,0 +1,12 @@ +# Installation + +[op-alloy][op-alloy] consists of a number of crates that provide a range of functionality +essential for interfacing with any OP Stack chain. + +## Crates + +TODO + +## `no_std` + +TODO