README from code/description
Generates a professional README.md with all the expected sections (install, usage, API, license).
No more "TODO: add README" sitting in your repo for 6 months.
The prompt
Copy this into ChatGPT, Claude, Gemini or any assistant you already use — then paste your own project description + code/snippets underneath it.
Generate a complete README.md in GitHub-flavoured markdown. Sections in this order: 1. Project name + 1-line tagline 2. Badges (npm, license, build — placeholders if unknown) 3. Quick intro (2-3 sentences) 4. Features (bulleted) 5. Install (code block with the install command) 6. Quick start (code block, smallest useful example) 7. API reference (function signatures + 1-line descriptions) 8. Configuration (env vars / options table) 9. Examples (1-2 longer code samples) 10. Contributing (1 short paragraph) 11. License Rules: - No emojis in section headings. - Code blocks must specify language. - If the project description is thin, mark unknowns as [TODO].
Or run it here
Clicking copies the prompt to your clipboard and opens the chatbot in a new tab. Gemini doesn't accept URL params — paste manually with Ctrl/Cmd+V.
Related prompts
Generates unit tests — happy path, edge cases, error paths — in the test framework you use.
Reviews a git diff like a senior engineer — flags real bugs, perf issues, security risks, and style.
Writes a clean conventional-commits message (feat/fix/chore/etc.) from a diff or description.
Decodes a regex into plain English, character-class by character-class.
Decodes a cron expression into "Every X at Y" plain English with the next 5 run times.
Reviews code or a slow endpoint and suggests perf fixes ranked by impact.
Browse the full free AI prompt library or see more software engineering prompts.