Skip to content

docs: polish the README for v0.1.0 - #109

Merged
hmdsefi merged 1 commit into
mainfrom
docs/readme-discovery
Oct 20, 2026
Merged

hmdsefi merged 1 commit into
mainfrom
docs/readme-discovery

Conversation

@hmdsefi

@hmdsefi hmdsefi commented Oct 20, 2026

Copy link
Copy Markdown
Owner

Rewrites the README for v0.1.0 and for GitHub search and pkg.go.dev.

  • Replaces "Status: design phase" with what v0.1.0 contains, linking the roadmap issue for later versions.
  • Adds the badge row (build, coverage, Go Reference, release, Go version, license, sponsor) and links to the documentation, roadmap and changelog.
  • Adds install instructions and a runnable example: the banner's log (block 101 replaced by 101') applied by a consumer.Memory, printing [a0 b1]. I ran it against main.
  • Adds a package list linking to pkg.go.dev, and a related-projects section (Ponder, Envio HyperIndex, SQD, The Graph, rindexer, Shovel) for readers searching by those names.
  • Removes "Built with gograph": gograph isn't a dependency in v0.1.0.
  • Keeps "What evmsync means here" and the replica table, without the em dash and "seamlessly", and drops "in parallel" from the backfill row, since parallel backfill is planned for v0.5.

The Changelog link resolves once the CHANGELOG PR merges.

@hmdsefi
hmdsefi merged commit c1d474b into main Oct 20, 2026
9 checks passed
@hmdsefi
hmdsefi deleted the docs/readme-discovery branch October 20, 2026 15:17
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.

1 participant