awesome-readmelisted
Install: claude install-skill fralapo/awesome-agent-skills
# Awesome README Engineering
A GitHub README is the front door of a project. The best ones combine a clear value proposition above the fold, scannable structure, credibility signals (badges, contributors, stars), copy-pasteable install/usage, visuals (banner, demo GIF, screenshots), and — most overlooked of all — prose that sounds like a human wrote it.
That last point is non-negotiable. A visitor smells AI-generated marketing copy in seconds. Once they do, every other quality signal on the page loses its weight. See [references/voice-and-prose.md](references/voice-and-prose.md) for the full anti-AI-slop protocol; apply it to every draft before writing to disk.
This skill produces **two kinds** of READMEs:
| Kind | Lives at | Purpose |
|---|---|---|
| **Project README** | `repo-root/README.md` | Sells and explains a software project to potential users / contributors |
| **Profile README** | `username/username/README.md` (special repo) | Personal GitHub landing page — bio, skills, stats, socials |
Grammar differs per kind. See [references/profile-readme.md](references/profile-readme.md) for profile specifics.
## When to Use This Skill
Trigger on any of:
- "Write / generate / create a README for this repo"
- "Improve / refactor / audit the README"
- "Add badges / TOC / demo GIF / logo / banner"
- "Make my GitHub profile README"
- "Make my README look like an awesome-readme entry"
- "Convert this project description into a README"
- User mentions: `shields.io`, `contrib.