README Generator

---
name: readme-gen
description: |
  Generate comprehensive README files from a codebase. Trigger when the user
  needs a README, project documentation, or wants to improve their existing
  README. Phrases: "generate README", "write a README", "update README",
  "project documentation".
allowed-tools:
  - Read
  - Glob
  - Grep
  - Write
  - Bash(cat package.json)
  - Bash(cat Cargo.toml)
  - Bash(cat go.mod)
---

# README Generator

Generate polished, comprehensive READMEs by analyzing the actual codebase.
Includes badges, installation, API documentation, examples, and contributing
guidelines.

## Workflow

1. **Scan** the project structure (package.json, src/, tests/)
2. **Identify** the stack, dependencies, and project type
3. **Extract** public API, CLI commands, or exported functions
4. **Generate** structured README with all standard sections

## Sections included

1. Project title + one-line description
2. Badges (build, version, license, coverage)
3. Features (bulleted, from actual capabilities)
4. Installation (exact commands from package manager)
5. Quick start (minimal working example)
6. API reference (from exported functions/endpoints)
7. Configuration (env vars, config files)
8. Development (setup, test, build commands)
9. Contributing guidelines
10. License

## Example usage

- "Generate a README for this project"
- "Update the README to reflect the new API"
- "Add a quick start section to the README"

## Requirements

- Access to project source code
- package.json / Cargo.toml / go.mod for dependency info