readme-creator
Installation
SKILL.md
README Creator
Write or rewrite a README.md tailored to the project type and audience.
- IS: producing a new or rewritten README.md, selecting structure from the detected project type (CLI, library, app, framework, monorepo, skill bundle) and writing each section.
- IS NOT: auditing or improving an existing README's prose, or writing a multi-page docs site (use
docs-writing); writing AGENTS.md or CLAUDE.md agent-instruction files (useagents-md). A README that already covers the project and just needs polish is adocs-writingjob, not a rewrite.
Reference Files
| File | Read when |
|---|---|
references/section-templates.md |
Phase 3, after the project type is known: copy the matching skeleton and section guidance |
references/badges-and-shields.md |
Phase 4, only if the project publishes to a registry |
references/quality-checklist.md |
Phase 5: score the finished README before declaring done |
Workflow
Copy this checklist to track progress: