standard-readme

Installation
SKILL.md

Standard Readme

Generate and audit README.md files that comply with the 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)
Related skills

More from tenequm/skills

Installs
17
Repository
tenequm/skills
GitHub Stars
27
First Seen
Apr 2, 2026