From 00da5b11539ae467deb69977d351be9f23f2b794 Mon Sep 17 00:00:00 2001 From: dancoombs Date: Wed, 27 Sep 2023 08:34:18 -0400 Subject: [PATCH] chore(docs): readme updates --- CONTRIBUTING.md | 2 +- README.md | 8 ++++---- docs/README.md | 13 +++++++++++++ docs/architecture/{architecture.md => README.md} | 0 4 files changed, 18 insertions(+), 5 deletions(-) create mode 100644 docs/README.md rename docs/architecture/{architecture.md => README.md} (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee875de38..90fbdf599 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ It should be considered as a guide to help you navigate the process. The [Telegram][dev-tg] is available for any concerns you may have that are not covered in this guide. -If you contribute to this project, your contributions will be made to the project under the project's GNU Lesser General Public Library v3.0 license. +If you contribute to this project, your contributions will be made to the project as follow: (a) contributions to the Rundler library (i.e. all code outside of the `bin` directory) will be licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file; and (b) contributions to the Rundler binaries (i.e. all code inside of the `bin` directory) will be licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file. ### Ways to contribute diff --git a/README.md b/README.md index a9113aede..e149f8af9 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,13 @@ 🚧 *Under active development, see [status](#status) below.* 🚧 -## What's a Rundler? +## Overview **Rundler** (**R**ust B**undler**) is an [ERC-4337][eip_link] bundler implementation written in Rust. Rundler is designed to achieve high-performance and high-reliability in cloud deployments via a modular architecture. Built, maintained, and used by [Alchemy](https://www.alchemy.com/) to push the limits of user experience on EVM chains via [Account Abstraction](https://www.alchemy.com/blog/account-abstraction). -## Goals +### Goals Rundler is meant to power the ERC-4337 ecosystem with an implementation that users can rely on to scale to their needs while maintaining high reliability. As ERC-4337 is a nascent technology, Rundler strives to be on the bleeding edge of feature support and the team will be contributing to push the protocol forward. @@ -107,10 +107,10 @@ See [SECURITY.md](SECURITY.md) for details. ## Acknowledgements -We stand on the shoulders of the following teams: +The work on this project would not have been possible without the amazing contributions from: - [ERC-4337 team](https://github.com/eth-infinitism/account-abstraction): The ERC-4337 team has pioneered the standard, and has answered countless questions during our development. They developed the [bundler reference implementation](https://github.com/eth-infinitism/bundler) and [spec tests](https://github.com/eth-infinitism/bundler-spec-tests) that were invaluable during our development process. We are excited to continue to work with this team to push ERC-4337 ahead. -- [Reth](https://github.com/paradigmxyz/reth): Big thanks to the Reth team, from which we've taken inspiration for many of our practices in this repo (including this README). They are pushing the Ethereum Rust ecosystem forward in an open way. We thank the Reth team for their continued contributions. +- [Reth](https://github.com/paradigmxyz/reth): Shout-out to the Reth team, from which we've taken inspiration for many of our practices in this repo (including this README). They are pushing the Ethereum Rust ecosystem forward in an open way. We thank the Reth team for their continued contributions. [eip_link]: https://eips.ethereum.org/EIPS/eip-4337 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..b51b61da3 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,13 @@ +# Rundler Documentation + +**Knowledge source for all things Rundler.** + +[CLI](./cli.md): Commands and configuration for the Rundler binary. + +[Developing](./developing.md): Instructions on how to develop in the Rundler repo. + +[Architecture](./architecture/): Information on the inner workings and features of Rundler. + +[Docker](./docker.md): Instructions for building and running Docker images. + +[Proto](./proto.md): Protobuf usage and best practices. diff --git a/docs/architecture/architecture.md b/docs/architecture/README.md similarity index 100% rename from docs/architecture/architecture.md rename to docs/architecture/README.md