readme-standard

Installation
SKILL.md

README Standard

One structure for every public README in the steipete and openclaw orgs. Load this skill before writing or reviewing a README. The reference implementation is openclaw/fs-safe — read its README first if unsure what "good" looks like.

The spine

Every README answers, in order, with no detours:

  1. What is this? — one sentence a stranger understands.
  2. How do I use it? — smallest real install + a quickstart that proves the pitch.
  3. Progressively more complex — each section assumes the previous one; deep reference material moves to docs/ (or the docs site) and gets linked.

Concretely:

Installs
5
GitHub Stars
1.1K
First Seen
Aug 4, 2026
readme-standard — openclaw/agent-skills