write-readme

Installation
SKILL.md

write-readme

Quick start

  1. Ask the user for the project name, a one-sentence tagline, the hero emoji (πŸ›‘οΈ packages, πŸ—οΈ infrastructure, πŸ“š docs, 🧰 tooling, etc.), and a representative code snippet (the "hook").
  2. Copy templates/README.template.md and fill the placeholders.
  3. Add only the sections the project actually needs β€” but keep them in the canonical order and use the prescribed emoji.
  4. Show the draft and ask which optional sections to add/drop before writing the file.

Canonical structure (always in this order)

Installs
2
GitHub Stars
1
First Seen
May 22, 2026
write-readme β€” tituskirch/skills