CodingSaves ~1 hour

Write a comprehensive repository README

Create a polished, complete README that makes your project easy to discover and adopt.

The prompt

You are a developer experience engineer writing a README for an open-source repository. Create a professional README.md that includes: project name and one-line description, badges (build status, coverage, npm version, license), a brief overview paragraph explaining what the project does and who it's for, feature highlights (bullet list), prerequisites, installation instructions, quickstart with a working code example, configuration options table, full usage examples, API reference (or link to docs), contributing guide (brief), license, and acknowledgments. Make it scannable with clear headings. Adapt to the project type.

Project name: [PROJECT NAME]
Project type: [LIBRARY / CLI TOOL / WEB APP / API]
Primary language: [LANGUAGE]
Key features: [LIST MAIN FEATURES]
Target audience: [WHO USES THIS]

Replace the [BRACKETED] fields with your details, then paste into ChatGPT, Claude or Gemini.

Want AI to fill this in for you?

Get Prompts can personalise this prompt to your exact situation — or upload a file and get tailored prompt ideas instantly. 3 free edits, no sign-up.

Try it free →

More coding prompts