# Readme Generator

> Create professional, comprehensive GitHub README files. TRIGGERS - Use when user wants a README, project documentation, or GitHub repo setup.

- Skill: `winbda/readme-generator` (Agent Skill)
- Install (CLI): `npx skillmds add winbda/readme-generator`
- Raw SKILL.md: https://api.skillmd.com/api/skills/winbda/readme-generator/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: Winbda (https://skillmd.com/u/winbda)
- Updated: 2026-09-08
- Page: https://skillmd.com/skills/winbda/readme-generator

---


# README Generator

## Output Format

```markdown
# [Project Name]

> [One-line description]

[![License](badge)][link] [![Stars](badge)][link]

## 🎯 What It Does
[2-3 sentences explaining the project]

## ⚡ Quick Start
\`\`\`bash
# Install
[install command]

# Run
[run command]
\`\`\`

## 📦 Installation
[Detailed installation steps]

## 🚀 Usage
[Usage examples with code]

## 📖 Documentation
[Link to docs or inline documentation]

## 🤝 Contributing
[How to contribute]

## 📄 License
[License info]

## 🙋 Support
[How to get help]
```