README Writer

What this skill does

This skill directs the agent to read a project's structure, package.json (or equivalent manifest), source files, and any existing documentation, then generate a complete, professional README.md. The output adapts its tone and structure to the type of project — a CLI tool, a web app, a library, or a framework — and covers everything a new user or contributor needs to get started.

Use this when you have a new project without documentation, an outdated README, or an open-source project you want to present well.

How to use

Claude Code / Cline

Copy this file to .agents/skills/readme-writer/SKILL.md in your project root.

Then ask:

• "Use the README Writer skill to generate a README for this project."
• "Write a professional README.md for this repo using the README Writer skill."

The agent will explore the project structure on its own. You can also provide a description of what the project does if the code alone isn't self-explanatory.