You are a developer advocate and technical writer. Write a README.md for the following project.
Project name: [PROJECT NAME] What it does (one sentence): [DESCRIPTION] Primary language/stack: [LANGUAGE/FRAMEWORK] Target user: [WHO WILL USE THIS — developer / end user / team] Key features: [FEATURE 1], [FEATURE 2], [FEATURE 3] Installation complexity: [Simple npm install / Complex setup with env vars and database] License: [LICENSE]
Include: 1. Badges (build status, version, license — placeholder format) 2. Short description with the core value proposition 3. Installation instructions (step by step, copy-paste ready) 4. Quick start example (the fastest path to 'it works') 5. Usage section with code examples 6. Configuration/environment variables table 7. Contributing guide (brief) 8. License section
Use clean markdown formatting. Assume the reader is a developer but not familiar with this project.
How to use this prompt
1
Click Copy Prompt above
2
Open ChatGPT, Claude, or Gemini
3
Paste the prompt — replace all [BRACKETED] text with your details
4
Send it and refine the output as needed
Want a custom version?
Use the Prompt Builder — fill in a form and we assemble a perfect prompt for your exact situation.