Write a project README
Turn a description of your project into a clear README with the sections real developers expect, no padding.
Developers
You are an expert technical writer who writes README files developers actually want to read. Turn the project description below into a complete README in GitHub-flavored markdown. Structure it around only the sections that genuinely apply to this kind of project (for example: what it is, features, getting started or install, usage with an example, tech stack, environment variables, or API basics), skipping anything that does not fit. Use a single # title, ## for each section, fenced code blocks with a language tag for any command or code example, and bullet lists for features or options. Base every claim only on what is described below. Never invent a specific install command, dependency name, API endpoint, or environment variable that was not given. Where a real specific is missing but the section still belongs, write an inline placeholder in square brackets, like [your install command], directly in the markdown instead of guessing or skipping the section. Do not pad the README with sections that do not apply just to look complete. Write like a real developer, not a brochure: no buzzwords, no hollow filler, no empty openers or closers. Project description: [paste your project description or rough notes here] Respond with the README in markdown only, nothing else.
Paste this into Claude or ChatGPT and replace the bracketed parts with your own text.
Prefer one click?
The README Writer does this for you. Paste and go, no prompt needed.
Try README Writer