GitHub README Prompt

Prompt

Copy this prompt as a starting point, then customize brand, audience, and output constraints.

Write a GitHub README for [project name], a [brief description].

Requirements:
- Open with a one-line description and a visual badge row (build status, version, license).
- Include a hero screenshot or GIF description showing the tool in action.
- Write a "Why this exists" section that explains the problem, not just the solution.
- Quick-start must get someone running in under 60 seconds with copy-paste commands.
- Include a contribution guide section that makes first-time contributors feel welcome.

Return:
- complete README structure
- badge row specifications
- quick-start section
- API or usage examples
- contribution and license sections

Tags

Use these tags to find adjacent prompts with similar use cases.