readme-writer

Installation
SKILL.md

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:

Installs
3
GitHub Stars
1.4K
First Seen
Aug 5, 2026
readme-writer — mohitagw15856/pm-claude-skills