standard-readme

# Standard Readme Generate and audit README.md files that comply with the [Standard Readme](https://github.com/RichardLitt/standard-readme) specification. ## Two Modes **Write mode** (default): Generate a new README or rewrite an existing one. **Audit mode**: When the user asks to "check", "audit", "review", or "lint" a README, analyze it against the spec and report issues without rewriting. --- ## The Specification A compliant README has sections in this exact order. Some are required, some optional. Optional sections should be included only when they add real value for the project - don't pad the README with empty sections. ### Section Order ``` 1. Title REQUIRED (H1) 2. Banner optional (image, no heading) 3. Badges optional (no heading) 4. Short Description REQUIRED (plain text, no heading) 5. Long Description optional (no heading) 6. Table of Contents REQUIRED* (H2) 7. Security optional (H2) 8. Background optional (H2) 9. Install REQUIRED** (H2) 10. Usage REQUIRED** (H2) 11. [Extra Sections] optional (H2, custom titles) 12. API optional (H2) 13. Maintainer(s) optional (H2) 14. Thanks / Credits optional (H2) 15. Contributing REQUIRED (H2) 16. License REQUIRED (H2, always last) ``` `*` Table of Contents is only re...