# Readme Generator

> Generates a polished README from your project structure and dependencies. Use when the user asks to write or improve a README.

- Skill: `nir130/readme-generator` (Agent Skill)
- Install (CLI): `npx skillmds@latest add nir130/readme-generator`
- Raw SKILL.md: https://api.skillmd.com/api/skills/nir130/readme-generator/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: nir130 (https://skillmd.com/u/nir130)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/nir130/readme-generator

---


# README Generator

When the user asks for a README:

1. Inspect the project: entry points, scripts in `package.json`/`pyproject.toml`,
   and the directory layout.
2. Draft a README with: title, one-line description, features, install, usage,
   and a project-structure section.
3. Keep it accurate — only document scripts and commands that actually exist.
4. Show the draft and ask before overwriting an existing README.