ujjwal502/readit

README preview

# ReadIt 📖

Turn any codebase into a **reference-grade book** — with chapters, runtime flows, and
Mermaid diagrams — so people actually understand what's happening instead of vibe
coding.

ReadIt is a [Claude Code](https://docs.claude.com/en/docs/claude-code) plugin. Point
it at a repo, run `/book`, and it produces a `book/` folder you can read front to
back or publish as docs.

**The bar:** after reading the book, a competent engineer should be able to answer
virtually any question about the system — design rationale, architecture, data flow,
contracts, edge cases, failure modes, and implementation details — *without going back
to search the source.* If a plausible question can't be answered from the book, the
book isn't done.

## What it answers

Every chapter is written against eight knowledge categories:

View full repository on GitHub →