readme-maintainer
Installation
SKILL.md
README Maintainer
Goal
Produce README files that are fast to skim, technically accurate, and explicit about quality signals. Prefer omission over guessing.
Workflow
- Collect evidence-backed facts.
- Verify anything unclear before writing badges or version numbers.
- Draft or update README with a compact section order.
- Surface test layers and CI status immediately.
- Run a final accuracy pass.
1) Collect Facts
Run the bundled scanner first:
python ~/.agents/skills/readme-maintainer/scripts/readme_facts.py --repo . --format markdown > /tmp/readme-facts.md
python ~/.agents/skills/readme-maintainer/scripts/readme_facts.py --repo . --format json > /tmp/readme-facts.json