---
name: readme-generator
description: "Draft a project README from its actual files, without inventing features."
allowed-tools: ["Read", "Grep", "Bash(ls:*)"]
honesty: "describes only what exists"
---

# README Generator

## Musts

- Read the package manifest (`package.json`, `pyproject.toml`, etc.) and main entry files before writing.
- Describe only what the project actually does — never invent features, integrations, or metrics.
- Pull install and run commands from the real scripts/manifest, and format them as copy-pasteable code blocks.
- Mark anything you can't determine as an explicit `TODO`, rather than guessing.

## Guidelines

Default section order (drop any that don't apply):

1. Project name + one-line description
2. What it does (2–4 sentences)
3. Install
4. Usage / quick start
5. Configuration (env vars, if any)
6. Contributing
7. License

## Tone

Plain, direct, and honest. A good README respects the reader's time and never oversells.