readme-creator
Installation
SKILL.md
README Creator
Create clear, professional README.md files grounded in the actual project.
Required Sections (always include)
- Title + Description — Project name as
# Title, followed by 1–3 sentences: what it does and its purpose. No badges unless provided. - Features — Bulleted list of key capabilities. Be specific; don't invent features.
- Installation — Exact commands to install the project and its dependencies.
- Usage — Minimal working example(s) with code blocks. Show the most common use case first.
- Contributing — Brief guide: fork → branch → PR. One short paragraph or 3–4 bullets.
- License — State the license. Default to MIT if unspecified:
Distributed under the MIT License.
Conditional Sections (include only when justified)
- Prerequisites — Only if the project requires specific runtimes, accounts, environment variables, or non-obvious tools. Skip if setup is standard (e.g., just
npm install).