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