readme-that-converts
Skill1 starsChanged 3 months agoMITView on GitHub
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.
1 other project uses a version of this.
Adopted by
Most recently taken up by
- thanatchon36/skillstheir own version, first seen Oct 15, 2026
Other versions1 project uses a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 1
- thanatchon36/skills★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository16 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- add-testsSkill
- cut-a-releaseSkill
- env-and-configSkill
- license-and-legalSkill
- lint-and-formatSkill
- one-command-runSkill
- package-for-npmSkill
- package-for-pypiSkill
- repo-hygiene-passSkill
- security-basicsSkill
- set-up-ciSkill
- ship-checklistSkill
- ship-contextSkill
- write-a-changelogSkill
The file
Files
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.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.