-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
### Description Sets up the initial structure for the `op-alloy` book.
- Loading branch information
Showing
7 changed files
with
64 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Rollup Configs | ||
|
||
|
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,45 @@ | ||
# op-alloy Book | ||
|
||
_Documentation for op-alloy._ | ||
|
||
<a href="https://github.com/alloy-rs/op-alloy"><img src="https://img.shields.io/badge/GitHub%20Repo-op-alloy-green?logo=github"></a> | ||
|
||
> 📖 `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}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |