readme: overhaul for growth — lead with self-correction hook

[rohitg00]

Summary

• Restructure README to lead with the problem/solution (self-correcting memory) instead of version changelog
• New hero: "Your Claude Code gets smarter every session"
• Problem statement first: "You correct Claude the same way 50 times"
• Self-correction loop demo with session progression
• Install section moved up to top
• Star history chart added for social proof
• Cleaner feature tables for skills, agents, commands, hooks
• Cross-agent support simplified
• Removed v3.0 changelog from top (assumes prior knowledge new visitors don't have)

Why

Based on competitive analysis: repos leading with a clear single hook (claude-mem → memory, claude-hud → visibility, gstack → "use my setup") grow 10-50x faster. Pro-workflow's unique differentiator is the self-correction loop — no competitor has a persistent SQLite learning database that compounds over sessions.

Test plan

• Verify README renders correctly on GitHub
• Check all links work
• Star history chart loads in both light/dark modes
• SVG assets still display correctly

Summary by CodeRabbit

• Documentation
  • Repositioned README around "self-correcting memory" functionality persisting across 50+ sessions
  • Simplified installation instructions with a 30-second quick start option
  • Updated available skills (17), commands (16), agents (6), and reference guides
  • Reorganized structure with new sections for core patterns and cross-agent tool support

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2e88cdda-0067-4c4b-bf3f-3477aa2da795

📥 Commits

Reviewing files that changed from the base of the PR and between 9d1bd15 and 12f16af.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

README.md was substantially rewritten to reposition the project around self-correcting memory persisting across 50+ sessions. The update simplified installation instructions, reorganized command and documentation sections, removed detailed "How It Works" diagrams and expanded tables, and restructured content to introduce "Core Patterns," "Cross-Agent Support," and "Star History" sections while consolidating earlier detailed discussions.

Changes

Cohort / File(s)

Summary

Documentation Restructure README.md

Repositioned around self-correcting memory concept with tagline header. Removed detailed "How It Works" section and self-correction loop explanation. Simplified installation to single 30-second block. Updated "Try It" slash-command sequence with /learn-rule. Updated skill count to 17, reference guides to 10 (added core-rules.md), commands to 16 (added /safe-mode, /sprint-status), and agents to 6. Condensed hook documentation from lifecycle diagram to "23 Hook Scripts (18 Events)" table. Reorganized into "Core Patterns," "Cross-Agent Support," "Configuration," "Structure," and "Star History" sections.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related PRs

• feat: add Claude Code best practices to /learn command #6: Shares overlapping modifications to README and command/rule documentation surfaces
• Add decision framework, safety modes, sprint tracking #33: Adds identical skills and commands (/safe-mode, /sprint-status) reflected in this README restructuring
• feat: add Cursor marketplace plugin #17: Also modifies README and introduces learn-rule/self-correction entries

Poem

🐰 Whiskers twitching with delight,
Memory now persists so bright,
Fifty sessions, learning true,
Self-correcting all the way through!
Rules and patterns, clean and tight,
The README shines in morning light! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'readme: overhaul for growth — lead with self-correction hook' accurately describes the main change: a comprehensive README restructure emphasizing self-correction as the key differentiator, which aligns perfectly with the raw summary and PR objectives.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/readme-overhaul-growth

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}