Professional README Generator
Create a comprehensive, professional README.md for an open-source project with all essential sections.
Prompt
Create a comprehensive, professional README.md file for the following project:
Project Information
- Project Name: [Specify project name]
- Project Type: [npm package / Python library / CLI tool / web application / mobile app]
- Tech Stack: [e.g., TypeScript, React, Next.js, Python, Django, etc.]
- License: MIT
- Current Version: 1.0.0
Project Description
- One-line pitch: [Provide a compelling one-liner about what this project does]
- Main purpose: [What problem does it solve?]
- Target audience: [Who is this for?]
- Key differentiators: [Why choose this over alternatives?]
Key Features to Highlight
List 5-6 main features with descriptive icons:
- [Feature 1 - e.g., "Fast performance"]
- [Feature 2 - e.g., "Type-safe with full TypeScript support"]
- [Feature 3 - e.g., "Zero configuration required"]
- [Feature 4 - e.g., "Extensible plugin architecture"]
- [Feature 5 - e.g., "Comprehensive documentation"]
Installation & Usage
- Package manager: [npm / yarn / pip / cargo]
- Package name: [package-name]
- Basic usage example: [Provide a simple code snippet showing the most common use case]
README Structure to Include
Create a professional README with these sections:
-
Header
- Project logo/banner (placeholder path: ./assets/logo.png)
- Status badges (build, version, license, coverage)
- One-line project description
-
Table of Contents - Quick navigation links
-
About - Extended description answering what, why, who, and how
-
Features - Bulleted list with emoji icons for visual appeal
-
Demo - Placeholder for screenshots (./screenshots/demo.gif) or live demo link
-
Quick Start
- Installation instructions for the specified package manager
- Basic usage code example with syntax highlighting
- Expected output
-
Documentation - Link to full docs (if applicable)
-
API Reference (if it's a library)
- Main functions/methods with parameters, return types, and examples
- Use clear formatting with tables or code blocks
-
Configuration (if applicable)
- Configuration options in a table format with type, default, and description
-
Contributing
- Standard fork/branch/PR workflow
- Link to CONTRIBUTING.md
-
Roadmap
- Checked items for completed features
- Unchecked items for planned features
-
License - MIT with link to LICENSE file
-
Support/Contact
- Email, Discord, or GitHub issues links
Formatting Requirements
- Use appropriate emoji icons sparingly for visual appeal
- Ensure all code blocks have proper syntax highlighting
- Make it scannable with clear headers and bullet points
- Include placeholder image paths where relevant
- Use tables for configuration options
- Keep professional tone throughout
- Optimize for GitHub rendering
Generate the complete README.md content ready to commit to a repository.