readme-generator

# README Generator Generate human-focused README files following current best practices. **Core principle:** README is for humans, not agents. Research → Analyze → Write. **Model recommendation:** Use `Task` tool with `model: haiku` for README generation — faster and cheaper for documentation tasks. ## When to Use - Creating README for new project - Rewriting outdated README - User asks "write/create/update README" ## Process ```dot digraph readme_flow { rankdir=TB; "1. Research best practices via Exa" [shape=box]; "2. Analyze project structure" [shape=box]; "3. Identify project type" [shape=diamond]; "4. Write README with appropriate sections" [shape=box]; "5. Commit and push if requested" [shape=box]; "1. Research best practices via Exa" -> "2. Analyze project structure"; "2. Analyze project structure" -> "3. Identify project type"; "3. Identify project type" -> "4. Write README with appropriate sections"; "4. Write README with appropriate sections" -> "5. Commit and push if requested"; } ``` ## Step 1: Research **Always search first** for current README best practices: ``` mcp__exa__web_search_exa: "best practices README.md {year} {project_type}" ``` Look for: - Current trends in README structure - Examples from similar projects - What sections are essential vs optional ## Step 2: Analyze Project Read these files to understand the project: - `CLAUDE.md` or existing docs - `package.json` / `pyproject.toml` / `Cargo.toml`...