readme-creator

name

readme-creator

description

Writes or rewrites README.md files tailored to the project type (CLI, library, app, framework, monorepo, or skill bundle). Discovers project context, selects the right structure, writes section by section, and validates against quality checks. Use when creating a README, writing a README from scratch, rewriting a bad README, bootstrapping project documentation, or asking "write a README for this project."

README Creator

Write or rewrite a README.md tailored to the project type and audience.

Reference Files

File	Read When
references/section-templates.md	Phase 3: choosing structure and writing sections for a specific project type
references/quality-checklist.md	Phase 5: validating the finished README against quality standards
references/badges-and-shields.md	Phase 4: adding badges after the main content is written

README Workflow

Copy this checklist to track progress:

README progress:
- [ ] Phase 1: Discover project context
- [ ] Phase 2: Choose README structure
- [ ] Phase 3: Write sections
- [ ] Phase 4: Add badges and extras
- [ ] Phase 5: Validate quality

Phase 1: Discover project context

Read the project before asking questions. Explore files to detect the project type:

• Read package.json, Cargo.toml, pyproject.toml, go.mod, or equivalent for name, description, license, dependencies, scripts, and bin field.
• Read existing README.md (if rewriting).
• Scan directory structure to understand architecture.

Classify into one of six project types: