Skip to content

docs: rewrite README hero for clarity#19

Merged
andresvio merged 1 commit intomainfrom
docs/readme-hero-rewrite
Mar 27, 2026
Merged

docs: rewrite README hero for clarity#19
andresvio merged 1 commit intomainfrom
docs/readme-hero-rewrite

Conversation

@andresvio
Copy link
Copy Markdown
Collaborator

Summary

  • Replace rhetoric-first hero with category-first positioning and scannable bullet list
  • Add agent evaluation prompt ("paste this into your agent") above the fold
  • Simplify install to go install + releases link (remove multi-line bash loop)
  • Move defensive copy ("NOT MCP", "why not files") to Design Decisions section
  • Replace all em dashes with standard punctuation (colons, periods, semicolons)

Test plan

  • Verify README renders correctly on GitHub (blockquote, GIF caption, badges)
  • Confirm all internal links still resolve

🤖 Generated with Claude Code

Replace rhetoric-first hero with category-first positioning, add
agent evaluation prompt, simplify install to go install + releases
link, move defensive copy (NOT MCP, why not files) to Design
Decisions, and replace all em dashes with standard punctuation.

Assisted-By: Claude Opus 4.6
@andresvio andresvio merged commit ccec2c3 into main Mar 27, 2026
4 checks passed
@andresvio andresvio deleted the docs/readme-hero-rewrite branch March 27, 2026 16:42
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