readme-creator
Installation
SKILL.md
README Creator
Write a README that reads as a shop window, not a wiki.
- IS: writing or rewriting
README.mdfor the person deciding whether to use the project, with the project type driving which capability sections earn a place and where the file will render (GitHub only, or also a registry page) driving image and badge choices. - IS NOT: polishing the prose of a README that already covers the project, or a multi-page docs site (use
docs-writing); AGENTS.md or CLAUDE.md agent-instruction files (useagents-md); fixing the install or first-run experience the README describes (usedx-audit); marketing copy for a landing page (usecopywriting).
The reader
Someone arrived from a search result, a registry listing, or a profile page. They have about fifteen seconds and one question: is this worth my time? Every line either answers that or gets cut.
They are not a contributor. Nothing about the build pipeline, the workspace layout, the release process, or the coding standards helps them decide, so none of it belongs here.
This deliberately departs from standard-readme and Make a README, which require ## Contributing, add a table of contents past 100 lines, and hold that too long beats too short. Do not drift back to those defaults: contributor content moves to CONTRIBUTING.md or AGENTS.md, and length follows what the reader needs.