From b5c5057d6ef36ee5216a432f986f4129cecace54 Mon Sep 17 00:00:00 2001 From: init4samwise Date: Sat, 21 Mar 2026 07:09:08 +0000 Subject: [PATCH] docs: polish README for mainnet readiness Add CI and license badges, fix typo, reorder sections to lead with "What's new in Signet?", and move semver note to the bottom. Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 55 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 29 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 42c7067..fa5b6d9 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,13 @@ # Signet Node Components +[![CI](https://github.com/init4tech/node-components/actions/workflows/rust.yml/badge.svg)](https://github.com/init4tech/node-components/actions/workflows/rust.yml) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) + > **Note:** The `main` branch is in maintenance and bug-fix mode. The > `develop` branch contains current work. A collection of components for building the Signet node. These components -implement core node functionality, but are potentially indepedently useful. - -## What's in the Components? - -- **signet-node-types** - Shim types wrapping reth's internal node types - system to make it more usable in Signet. -- **signet-blobber** - Blob retrieval and parsing, using blob explorers, - Signet's Pylon, and the local node transaction API. -- **signet-rpc** - An Ethereum JSON-RPC Server for Signet nodes. Makes heavy - use of reth internals. -- **signet-db** - An extension of reth's database, providing a Signet-specific - database schema and utilities for working with Signet blocks and transactions. - -### Contributing to the Node Components - -Please see [CONTRIBUTING.md](CONTRIBUTING.md). - -[Signet docs]: https://signet.sh/docs - -## Note on Semver - -This repo is UNPUBLISHED and may NOT respect semantic versioning between tagged -versions. In general, it is versioned to match the signet-sdk version with -which it is compatible. I.e. `node-components@0.8.x` is expected to be -compatible with any signet-sdk `0.8.x` version. However, a release of -`node-components@0.8.1` may have breaking changes from `node-components@0.8.0`. +implement core node functionality, but are potentially independently useful. ## What's new in Signet? @@ -50,3 +28,28 @@ knowledge. Signet does not have a native token. Signet is just a rollup. See the [Signet docs] for more info. + +## What's in the Components? + +- **signet-node-types** — Shim types wrapping reth's internal node types + system to make it more usable in Signet. +- **signet-blobber** — Blob retrieval and parsing, using blob explorers, + Signet's Pylon, and the local node transaction API. +- **signet-rpc** — An Ethereum JSON-RPC Server for Signet nodes. Makes heavy + use of reth internals. +- **signet-db** — An extension of reth's database, providing a Signet-specific + database schema and utilities for working with Signet blocks and transactions. + +## Contributing + +Please see [CONTRIBUTING.md](CONTRIBUTING.md). + +## Note on Semver + +This repo is UNPUBLISHED and may NOT respect semantic versioning between tagged +versions. In general, it is versioned to match the signet-sdk version with +which it is compatible. I.e. `node-components@0.8.x` is expected to be +compatible with any signet-sdk `0.8.x` version. However, a release of +`node-components@0.8.1` may have breaking changes from `node-components@0.8.0`. + +[Signet docs]: https://signet.sh/docs