readme-doc

Description

Generate a complete README.md file for any software project. Use whenever the user asks to create, write, generate, or draft a README.md — the first document people see when they discover your project. Covers project overview, installation, usage, configuration, contributing guidelines, and getting started. This skill triggers when users need to document: project setup, installation instructions, quick start guide, usage examples, configuration options, contributing guidelines, or "how do I get started with this project". Do NOT trigger for detailed technical design (use Design.md), architecture docs (use Architecture.md), or comprehensive API docs (separate API documentation). A reusable SKILL.md agent skill by arsudsandesh97.

Community Metrics

Categories

• Skills

Tags

• skill
• claude-skill
• github
• en

Capabilities

• 2 stars
• SKILL.md package

Information