readme-reviewer

Installation
SKILL.md

README Reviewer & Generator

Analyze a codebase and produce a high-quality README.md that follows industry best practices.

Philosophy

A README is the front door to a project. It should answer five questions in under 60 seconds:

  1. What does this project do?
  2. Why does it exist (and why should I care)?
  3. How do I get it running?
  4. How do I use it?
  5. How can I contribute or get help?

Everything else is secondary. The skill prioritizes accuracy over boilerplate — every claim in the README must be verifiable from the codebase.


Workflow

Related skills
Installs
2
Repository
espennilsen/pi
GitHub Stars
103
First Seen
Apr 2, 2026