README Generator

Create a professional README for a project or repository

🧪 Tested by a human Beginner 👤 Developer 👤 Tech Lead 👤 Open Source
Generate a README.md for [PROJECT NAME]. Include: (1) Project description and purpose, (2) Features list, (3) Quick start guide with installation steps, (4) Usage examples with code snippets, (5) Configuration options, (6) Contributing guidelines, (7) License information, (8) Badge suggestions (build status, coverage, version). Based on: [DESCRIBE THE PROJECT].

Works on

⭐ ChatGPT (Best) 🟠 Claude

Copy & Open in

🟢 ChatGPT 🟠 Claude

Prompt is copied to your clipboard when you click

Tips for Best Results

  • A good README is the most important file in any repository
  • Include a screenshot or GIF for visual projects
  • Keep the quick start to under 3 commands

📎 More Prompts

API Documentation Generator

●●
Generate API documentation for [API NAME]. For each endpoint include: (1) HTTP method and path, (2) Description of what it does, (3) Request parameters with types and required/optional, (4) Request body schema with examples, (5) Response schema with examples, (6) Error codes and meanings, (7) Authentication requirements. Format as Markdown.
🟢 GPT ⭐ Claude

Code Review Assistant

●●
Review this code and provide feedback on: (1) Bugs or logic errors, (2) Security vulnerabilities, (3) Performance issues, (4) Readability and naming, (5) Missing error handling, (6) Test coverage gaps. For each issue: explain the problem, show the fix, and rate severity (critical, important, minor). [PASTE CODE]
🟢 GPT ⭐ Claude

Database Migration Script

●●●
Write a migration script for [CHANGE]. Include: up migration, down migration (rollback), data preservation, validation queries, estimated execution time. Include safety checks.
⭐ M365 🟢 GPT 🟠 Claude
💬