Skip to content

v0.1.0 — first release

Latest
Latest

Choose a tag to compare

View all tags
@albertogrande albertogrande released this 20 Jul 14:24
v0.1.0
8ba4e2f

First public release of readme-standard: a living system of state-of-the-art README practices, installable as a Claude Code skill.

What's inside

  • Cited knowledge base — 8 reference files (anatomy, section guide, badges, checklist, anti-patterns, AI-era guidance, project types, annotated sources) synthesized from canonical standards, a 20-README structural sample, GitHub's platform docs, and 2025–2026 research on how coding agents consume docs.
  • 6 templates — library, CLI tool, web app, API/service, research/data, minimal.
  • readme skill — generate and review modes; classifies a project and applies the matching standard.
  • refresh-research maintainer skill — re-runs the research protocol, diffs against the KB, and dates every change, so the system stays current.

Install

/plugin marketplace add albertogrande/readme-standard
/plugin install readme-standard@readme-standard

Verified

Generate mode produced an accurate README for a scratch CLI; review mode scored a defect-seeded README 26/100 (catching every planted anti-pattern plus a real ESM/CJS bug); a blind writer/reviewer split surfaced a genuine manifest/claim mismatch; and the GitHub install path resolves and loads cleanly.

See the CHANGELOG.

Assets 2
Loading