Skip to content

docs: rewrite README to follow standard structure#7

Merged
urmzd merged 1 commit intomainfrom
docs/readme-standards
Apr 4, 2026
Merged

docs: rewrite README to follow standard structure#7
urmzd merged 1 commit intomainfrom
docs/readme-standards

Conversation

@urmzd
Copy link
Copy Markdown
Owner

@urmzd urmzd commented Apr 4, 2026

Summary

  • Rewrite README with centered header, CI + crates.io badges, and standard section order (Features → Install → Quick Start → Usage → License)
  • Add Features section consolidating project capabilities into a scannable list
  • Add Install section with cargo add and from-source instructions
  • Update recipes table to match current justfile and fix truncated benchmark row

Test plan

  • Verify README renders correctly on GitHub
  • Confirm badge URLs resolve (CI workflow, crates.io)
  • Check all internal links (spec, cost model, GAP-SSE) work

Add centered header, CI/crates.io badges, and reorganize into
Features, Install, Quick Start, Usage sections. Update recipes
table to match current justfile and fix truncated benchmark row.
@urmzd urmzd merged commit bea03f6 into main Apr 4, 2026
@urmzd urmzd deleted the docs/readme-standards branch April 4, 2026 02:49
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