make-readme

Installation
SKILL.md

README Maker

Generate a professional README.md for any project — from 50-line minimal to 600-line comprehensive — with shields.io badges, styled headers, and structured sections. Interview the user to determine preferences, then produce the full README in one pass.

Step 1 — Detect Project Context

Before asking, scan the working directory for context clues:

  • Glob for package.json, pyproject.toml, Cargo.toml, go.mod — Read the first match to extract project name and version as pre-filled defaults
  • Check if README.md already exists — warn the user before overwriting
  • Note the primary language from the detected manifest file
  • For Plugin Collection detection: Glob for */.claude-plugin/plugin.json, */package.json in subdirectories. If 3+ sub-manifests are found, pre-select Plugin Collection in Step 2 and note the count.
  • If no manifest is found, skip pre-filling — rely entirely on user input in Step 2
Related skills
Installs
4
GitHub Stars
249
First Seen
Mar 10, 2026