Real file from a public repo · synced Aug 26, 2026
readme-creator
Writes or rewrites a project's README.md as a public-facing shop window with a centered header, one fast install, one runnable example, and nothing that only serves contributors. Detects project type (CLI, library, app, framework, monorepo, skill bundle) to pick capability sections, then validates against a quality checklist. Use when "write a README for this project", "create a README", "rewrite this bad README", "make my README consistent", "unify the READMEs across my repos", "my README is too long", "bootstrap project documentation", or "the create-next-app README is still here". For auditing an existing README's prose or a multi-page docs site, use docs-writing. For AGENTS.md or CLAUDE.md agent-instruction files, use agents-md.
Works with
Install in three steps
- 1
Download the ZIP
One file per agent, plus INSTALL.md with the exact paths below.
- 2
Claude Code: copy SKILL.md into your skills folder
.claude/skills/readme-creator/SKILL.md # this project ~/.claude/skills/readme-creator/SKILL.md # every project
- 3
Other agents: use the matching file
skill.mdc goes in Cursor’s .cursor/rules/. AGENTS.md works as GitHub Copilot instructions, a legacy .cursorrules, or a Codex / Gemini CLI instructions file.

