readme-writer
Write a clear, well-structured README for a software project or open-source repo. Use when asked to write or improve a README, document a project, or make a repo approachable. Produces a complete README — one-line pitch, badges, quickstart, usage, install, contributing, license — that gets someone from landing to running fast.
npx skills add mohitagw15856/pm-claude-skills --skill readme-writer --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# README Writer Skill The README is a project's front door — most people decide in seconds whether to use or bounce. This skill writes a clear, scannable README that answers *what is this, why should I care, how do I run it* immediately, then layers in the detail. Structured so a newcomer gets to a working result fast. ## Required Inputs Ask for these only if they aren't already provided: - **Project name & one-line purpose** — what it is and what problem it solves. - **Who it's for** — the target user/developer. - **Install & basic usage** — how to install and the simplest working example. - **Key features / differentiators** — the few things that matter most. - **Project facts** (optional) — language, license, links (docs, demo), contribution policy, status (alpha/stable). ## Output Format A complete `README.md`: ### [Project name] > One-line pitch — what it does and for whom. *(Badges line — build, version, license — as placeholders to fill.)* **Why [project]?** — 2–3 sentences or bullets: the problem and what makes this worth using (honest, specific). **Features** — the handful that matter, as a tight bullet list. **Quickstart** ``` # install # minimal working example ``` …with
- Required Inputs
- Output Format
- [Project name]
- Quality Checks
- Anti-Patterns
- Based On
What does the readme-writer skill do?
Write a clear, well-structured README for a software project or open-source repo. Use when asked to write or improve a README, document a project, or make a repo approachable. Produces a complete README — one-line pitch, badges, quickstart, usage, install, contributing, license — that gets someone from landing to running fast.
How do I install it?
Run `npx skills add mohitagw15856/pm-claude-skills --skill readme-writer --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From mohitagw15856/pm-claude-skills, a repository with 1,255 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.