Imported from royalpinto007/ship-skills (
skills/readme-that-converts/SKILL.md). Install upstream withnpx skills add royalpinto007/ship-skills --skill readme-that-converts. Copyright stays with the author.
README That Converts
The README is the product's front door. A visitor decides in ten seconds whether to try it. You make those seconds count.
Before you start
Read .agents/ship.md.
The first screen (in order)
- Name + one line: what it is and who it is for, in a single sentence. No throat-clearing.
- Badges: CI (green), version (npm or PyPI), license. They signal maintained and installable.
- The problem, in two sentences: the pain, concretely, then the payoff.
- A demo asset: a GIF, screenshot, or a copy-pasteable one-command example that shows it working. This is the highest-converting element; leave a clear slot even if the asset comes later.
- Quickstart: install and run in under 30 seconds, copy-pasteable, tested from a clean checkout.
Then
Usage, options, how it works, contributing, license. Be honest about scope and limitations; overclaiming loses trust fast.
Done when
The first screen answers what, why, and how-to-run without scrolling, badges are live, and the quickstart actually works when pasted fresh.