Skip to content

Commit 23ed864

Browse files
init4samwiseclaude
andauthored
docs: polish README for mainnet readiness (develop) (#116)
* 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) <noreply@anthropic.com> * docs: update component list for develop branch Replace signet-db (removed on develop) with signet-host-reth and signet-host-rpc which are new on this branch. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent c2ebda7 commit 23ed864

1 file changed

Lines changed: 31 additions & 26 deletions

File tree

README.md

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,13 @@
11
# Signet Node Components
22

3+
[![CI](https://github.com/init4tech/node-components/actions/workflows/rust.yml/badge.svg)](https://github.com/init4tech/node-components/actions/workflows/rust.yml)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
5+
36
> **Note:** The `main` branch is in maintenance and bug-fix mode. The
47
> `develop` branch contains current work.
58
69
A collection of components for building the Signet node. These components
7-
implement core node functionality, but are potentially indepedently useful.
8-
9-
## What's in the Components?
10-
11-
- **signet-node-types** - Shim types wrapping reth's internal node types
12-
system to make it more usable in Signet.
13-
- **signet-blobber** - Blob retrieval and parsing, using blob explorers,
14-
Signet's Pylon, and the local node transaction API.
15-
- **signet-rpc** - An Ethereum JSON-RPC Server for Signet nodes. Makes heavy
16-
use of reth internals.
17-
- **signet-db** - An extension of reth's database, providing a Signet-specific
18-
database schema and utilities for working with Signet blocks and transactions.
19-
20-
### Contributing to the Node Components
21-
22-
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
23-
24-
[Signet docs]: https://signet.sh/docs
25-
26-
## Note on Semver
27-
28-
This repo is UNPUBLISHED and may NOT respect semantic versioning between tagged
29-
versions. In general, it is versioned to match the signet-sdk version with
30-
which it is compatible. I.e. `node-components@0.8.x` is expected to be
31-
compatible with any signet-sdk `0.8.x` version. However, a release of
32-
`node-components@0.8.1` may have breaking changes from `node-components@0.8.0`.
10+
implement core node functionality, but are potentially independently useful.
3311

3412
## What's new in Signet?
3513

@@ -50,3 +28,30 @@ knowledge. Signet does not have a native token.
5028
Signet is just a rollup.
5129

5230
See the [Signet docs] for more info.
31+
32+
## What's in the Components?
33+
34+
- **signet-node-types** — Shim types wrapping reth's internal node types
35+
system to make it more usable in Signet.
36+
- **signet-blobber** — Blob retrieval and parsing, using blob explorers,
37+
Signet's Pylon, and the local node transaction API.
38+
- **signet-rpc** — An Ethereum JSON-RPC Server for Signet nodes. Makes heavy
39+
use of reth internals.
40+
- **signet-host-reth** — Reth ExEx implementation of the `HostNotifier` trait
41+
for signet-node.
42+
- **signet-host-rpc** — RPC-based implementation of the `HostNotifier` trait
43+
for signet-node.
44+
45+
## Contributing
46+
47+
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
48+
49+
## Note on Semver
50+
51+
This repo is UNPUBLISHED and may NOT respect semantic versioning between tagged
52+
versions. In general, it is versioned to match the signet-sdk version with
53+
which it is compatible. I.e. `node-components@0.8.x` is expected to be
54+
compatible with any signet-sdk `0.8.x` version. However, a release of
55+
`node-components@0.8.1` may have breaking changes from `node-components@0.8.0`.
56+
57+
[Signet docs]: https://signet.sh/docs

0 commit comments

Comments
 (0)