Skill

README writer

Drafts or improves a project README from what is actually in the repository. Use it when asking for a README or project documentation.

Free For Claude Code

How to use it

Save the file below as .claude/skills/readme-writer/SKILL.md in your project.
Run it in Claude Code with /readme-writer.

SKILL.md

.claude/skills/readme-writer/SKILL.md

---
name: readme-writer
description: Writes or improves a README based on the real contents of the project. Use when the user asks for a README, project docs, or setup instructions.
---

Read the existing README (if any), the package or dependency file, the top-level folders, and any scripts or config that show how the project is run.

Draft a README with these sections, leaving out any you cannot support from the files:

1. **What it is**: one or two plain sentences.
2. **Getting started**: the exact install and run commands found in the project.
3. **Project layout**: the main folders and what each is for.
4. **Common tasks**: build, test and deploy commands that exist.
5. **Contributing or help**: only if the repository has information on it.

Only write commands and facts you can confirm in the project. Mark anything you could not verify with a TODO for the user to fill in.

Show the draft first. Do not overwrite README.md until the user approves.