write-readme

Write READMEs for readers with short attention: what is it, when do I use it, how do I start, what should I not expect.

Workflow

1. Gather context: problem solved, target audience, current alternatives, sharpest value/proof, and non-goals.
2. Classify once: library, CLI/tool, or agent tool. Ask if unclear.
3. Cut before adding: remove duplicated inventories, badge noise, marketing claims, and copied --help tables.
4. Draft in inverted-pyramid order: plain value, install, common use, boundaries, then optional reference.
5. Put the most common invocation or import path in the first 30 lines.
6. Use REFERENCE.md only for section choices, not as a required template.
7. Final pass: every line must answer a likely reader question or change their next action.

Opening Rules