← ClaudeAtlas

readme-that-convertslisted

When a repo's README does not sell or explain the project in its first screen. Triggers: 'improve the README', 'README as landing page', 'my readme is weak', 'readme that converts'. Rewrites the top of the README to say what, why, and how fast, with badges and a demo slot.
royalpinto007/ship-skills · ★ 1 · Data & Documents · score 63
Install: claude install-skill royalpinto007/ship-skills
# 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) 1. **Name + one line:** what it is and who it is for, in a single sentence. No throat-clearing. 2. **Badges:** CI (green), version (npm or PyPI), license. They signal maintained and installable. 3. **The problem, in two sentences:** the pain, concretely, then the payoff. 4. **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. 5. **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.