Skip to content

docs: improve README with badges, nav links, better quick start, and contributing section#302

Merged
justrach merged 2 commits intomainfrom
worktree-readme-improvements
Mar 6, 2026
Merged

docs: improve README with badges, nav links, better quick start, and contributing section#302
justrach merged 2 commits intomainfrom
worktree-readme-improvements

Conversation

@justrach
Copy link
Copy Markdown
Owner

@justrach justrach commented Mar 6, 2026

Brings the README up to par with popular OSS repos.

Changes:

  • Add 5 shields.io badges (version, license, stars, Zig, MCP)
  • Centered hero with tagline and nav links
  • Binary download as primary install option (lower friction than build-from-source)
  • Collapse per-client config into <details> dropdowns
  • Add Contributing section (was missing entirely)
  • Move Requirements inline with Quick Start
  • Link LICENSE file from License section

@justrach justrach merged commit bfa31f3 into main Mar 6, 2026
1 check 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.

1 participant