write-clear-readme

Installation
SKILL.md
Contains Shell Commands

This skill contains shell command directives (!`command`) that may execute system commands. Review carefully before installing.

Write Clear README

Author, audit, or polish a README.md for clarity, conciseness, and scannable structure. Reads the repo state first; uses <details> collapse patterns where appropriate; proposes diffs and applies on approval.

Additional context from the user: $ARGUMENTS

Context

  • Repo: !basename $(git rev-parse --show-toplevel 2>/dev/null || echo unknown)
  • Existing README: !test -f README.md && wc -l < README.md | awk '{print $1 " lines"}' || echo "none"
  • Package manifest: !test -f package.json && jq -r '.name + "@" + .version' package.json 2>/dev/null || echo "none"
Related skills

More from coroboros/agent-skills

Installs
4
First Seen
Apr 29, 2026