documentationintermediate580 tokens

README.md for Open Source Project

Create compelling README files that drive adoption and contributions

readmeopen-sourcedocumentationgithub

Prompt Template

You are an open-source maintainer writing a README that converts visitors to users and users to contributors.

**Project:** {project_name}
**Description:** {short_description}
**Tech Stack:** {tech_stack}
**License:** {license}

Write a comprehensive README following this structure:

**1. Hero Section:**
```markdown
# {Project Name}

[![License]() [![Stars]() [![Issues]()

> One-line description that explains the value proposition

[Demo](link) | [Documentation](link) | [Discord](link)
```

**2. Problem & Solution:**
**Why {project_name}?**
- Problem 1: Existing solutions do X poorly
- Problem 2: No tool does Y
- Our solution: [unique approach]

**3. Features:**
- āœ… **Feature 1**: Concrete benefit
- āœ… **Feature 2**: Concrete benefit
- 🚧 **Feature 3** (coming soon)

**4. Quick Start:**
```bash
# Installation (one command that works)
npm install {project_name}

# Hello World example (under 10 lines)
```

**5. Demo:**
Show don't tell. Include:
- GIF/video of key use case (describe what should be shown)
- Before/after comparison
- Code example with output

**6. Installation:**
Cover all platforms:
- npm/pip/cargo/etc.
- Docker
- Build from source

**7. Usage:**
Start simple, increase complexity:

```
Basic Example
↓
Common Use Cases
↓
Advanced Configuration
```

For each section, show working code + expected output.

**8. Configuration:**
Table format:
| Option | Type | Default | Description |
|--------|------|---------|-------------|

**9. API Reference:**
Link to full docs, but show:
- 3 most common methods
- Parameters and return types
- Short example for each

**10. Contributing:**
- Link to CONTRIBUTING.md
- Good first issues label
- Development setup (< 5 commands)
- How to run tests

**11. Roadmap:**
- āœ… Shipped
- 🚧 In Progress
- šŸ“‹ Planned

**12. FAQ:**
Address top 3-5 questions:
- Why X instead of Y?
- Does it support Z?
- How does it compare to [competitor]?

**13. License & Credits:**
- License badge and link
- Contributors (if applicable)
- Acknowledgments

**14. Badges & Social Proof:**
Suggest relevant badges:
- Build status, coverage, version
- GitHub stars, downloads
- Sponsor button

Format in clean markdown with proper headings and code blocks.

Variables to Replace

{project_name}
{short_description}
{tech_stack}
{license}

Pro Tips

Great for launching new open-source projects or refreshing existing ones.

Need More Prompts?

Explore our full library of 60+ professional AI prompt templates

Browse All Prompts →