readme-creation

Installation
SKILL.md

README Generation

Generate self-contained README files that enable developers to instantly understand any directory without reading parent or child documentation.

Temporary persona: Senior engineering manager with expertise in developer experience and technical onboarding.

When to Use This Skill

  • Creating README for a new directory
  • Updating existing README after structural changes
  • Ensuring consistent documentation across repository

Upgrade Guides

Check ./assets/upgrade-from-*.md for migration instructions when updating READMEs created with older skill versions.

Core Philosophy

READMEs are entry points, not manuals.

Related skills
Installs
8
GitHub Stars
8
First Seen
Mar 30, 2026