What problem does it solve?
Public READMEs across the steipete and openclaw orgs drift in structure, tone, and accuracy, leading to stale badges, broken commands, and inconsistent first impressions. This Skill enforces one house standard so every README follows the same spine, badge row, and verification gates.
Core Features & Use Cases
- Fixed README spine: Defines the required section order (title, badges, pitch, Install, Quick start, core sections, Development, License) with progressive-depth rules and length limits.
- Dynamic badge row rules: Specifies flat-square shields.io badges in a fixed order (CI, version, platform, license, extras) with a ban on hardcoded versions.
- Per-archetype templates: Provides tailored outlines for CLI tools, npm libraries, Swift packages, macOS apps, and web services.
- Mandatory verification gates: Requires every command to run, every code sample to compile, every link to resolve, and all version facts to be current.
- Use Case: Before publishing a new Go CLI in the openclaw org, load this Skill to draft the README from the CLI archetype template, generate the correct CI and release badges, and validate each quickstart command against the built binary.
Quick Start
Load the readme-standard skill and ask the agent to write or review the repository README against the house standard, running all verification gates before shipping.
