configure-readme
Installation
SKILL.md
Contains Shell Commands
This skill contains shell command directives (!`command`) that may execute system commands. Review carefully before installing.
When to Use This Skill
| Use this skill when... | Use another approach when... |
|---|---|
| Creating a README.md for a new project from scratch | Editing specific README content — use direct file editing |
| Auditing an existing README for missing sections (badges, install, structure) | Writing detailed API documentation — use /configure:docs |
| Standardizing README format across multiple projects | Creating GitHub Pages documentation site — use /configure:github-pages |
| Adding shields.io badges, tech stack table, or project structure section | Writing a changelog — use release-please automation via conventional commits |
| Ensuring README includes correct install/build/test commands for the detected stack | Only need to update a single section — edit the file directly |