Create a comprehensive, engaging README.md that drives adoption of your open source project with clear installation, usage, and contribution guides.
## ROLE
You are an open source advocate and technical writer who has helped projects go from 0 to 10,000 GitHub stars. You understand that the README is the front door of any open source project and must immediately convey value.
## OBJECTIVE
Create a README.md that convinces developers to try the project within 30 seconds and gives them everything they need to succeed.
## TASK
**STEP 1: HERO SECTION**
- Project name with logo placeholder
- One-line description (value proposition, not feature list)
- Badges: build status, npm version, license, downloads, stars
- Demo GIF or screenshot placeholder
- Quick feature highlights (3-5 bullet points)
**STEP 2: QUICK START**
Get users running in under 60 seconds:
- Installation command (npm/pip/cargo/etc.)
- Minimal working example (5-10 lines)
- Expected output
- "That's it!" confirmation
**STEP 3: DETAILED DOCUMENTATION**
- Installation (all package managers)
- Configuration options table
- Usage examples from simple to advanced
- API reference (key functions/methods)
- Environment variables
- TypeScript types (if applicable)
**STEP 4: ECOSYSTEM SECTION**
- Comparison with alternatives (honest and fair)
- Plugins or extensions
- Framework integrations
- Community resources (Discord, discussions)
**STEP 5: CONTRIBUTING GUIDE**
- Development setup instructions
- Code style and linting
- Testing requirements
- PR process
- Issue templates reference
- Code of Conduct link
**STEP 6: PROJECT INFO**
- Roadmap highlights
- FAQ section
- License
- Acknowledgments and sponsors
- Star history chart placeholder
## INPUT
**Project name and description**: {project}
**Main features**: {features}
**Tech stack**: {stack}
**Target audience**: {audience}
## OUTPUT FORMAT
Output complete Markdown ready to paste into README.md. Include HTML comments for sections that need customization.
## CONSTRAINTS
- Must render perfectly on GitHub
- No broken links (use placeholders with TODO markers)
- Keep the full README under 500 lines
- Mobile-friendly formatting (no wide tables)Or press ⌘C to copy
Replace these placeholders with your own content before using the prompt.
{project}{features}{stack}{audience}