Skip to content

docs: polish README for mainnet readiness (develop)#116

Merged
prestwich merged 2 commits intodevelopfrom
samwise/readme-polish-develop
Mar 23, 2026
Merged

docs: polish README for mainnet readiness (develop)#116
prestwich merged 2 commits intodevelopfrom
samwise/readme-polish-develop

Conversation

@init4samwise
Copy link
Contributor

Summary

Port of #115 (samwise/readme-polish → main) to the develop branch.

  • Add CI status and MIT license badges
  • Fix typo: "indepedently" → "independently"
  • Reorder sections: lead with "What's new in Signet?" before component listing
  • Move semver note to bottom; use em-dashes in component list for consistency
  • Update component list for develop branch (replace signet-db with signet-host-reth and signet-host-rpc)

Crate list verification

main branch

README lists: signet-node-types, signet-blobber, signet-rpc, signet-db
Actual crates: signet-blobber, signet-db, signet-genesis, signet-node, signet-node-config, signet-node-tests, signet-node-types, signet-rpc
Missing from README: signet-genesis, signet-node, signet-node-config, signet-node-tests

develop branch (this PR)

README lists: signet-node-types, signet-blobber, signet-rpc, signet-host-reth, signet-host-rpc
Actual crates: signet-blobber, signet-genesis, signet-host-reth, signet-host-rpc, signet-node, signet-node-config, signet-node-tests, signet-node-types, signet-rpc
Missing from README: signet-genesis, signet-node, signet-node-config, signet-node-tests

Note: The unlisted crates (signet-node, signet-genesis, signet-node-config, signet-node-tests) are present on both branches but omitted from both READMEs. signet-node-tests is a test-only crate, and the others may be intentionally unlisted. Consider adding them in a follow-up.

Test plan

  • Verify badges render correctly on GitHub
  • Confirm all links resolve

🤖 Generated with Claude Code

init4samwise and others added 2 commits March 23, 2026 13:44
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>
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>
@init4samwise init4samwise requested a review from a team as a code owner March 23, 2026 13:45
@prestwich prestwich enabled auto-merge (squash) March 23, 2026 13:47
@prestwich prestwich merged commit 23ed864 into develop Mar 23, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants