readme-creator

Installation
SKILL.md

README Creator

Create clear, professional README.md files grounded in the actual project.

Required Sections (always include)

  1. Title + Description — Project name as # Title, followed by 1–3 sentences: what it does and its purpose. No badges unless provided.
  2. Features — Bulleted list of key capabilities. Be specific; don't invent features.
  3. Installation — Exact commands to install the project and its dependencies.
  4. Usage — Minimal working example(s) with code blocks. Show the most common use case first.
  5. Contributing — Brief guide: fork → branch → PR. One short paragraph or 3–4 bullets.
  6. 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).

Optional Sections (include when they add clear value)

Related skills
Installs
11
First Seen
Feb 20, 2026