# Readme

> Generate comprehensive README files for projects and repositories

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

---


# README Generation

Generate or update README.md for the current project:

1. Analyze project structure (package.json, composer.json, main files)
2. Identify key features and dependencies
3. Include installation instructions
4. Add usage examples with code snippets
5. Document configuration options
6. Follow WordPress/npm conventions as appropriate
7. Output in Markdown format with proper headings