README Generator

Build a polished README.md with live preview, badges, and one-click download.

README Generator

Client-side

About this tool

Writing a good README is repetitive: the same sections — description, installation, usage, license — get rebuilt from scratch on every new project. This tool turns that into a form. Fill in your project name, tagline, description, install steps, and a usage example, and get back clean, properly structured Markdown instantly, with a live-rendered preview alongside your input.

Pick from ~10 curated shields.io-style badges (build status, license, npm version, PRs welcome, and more) with a single click — no need to hand-write badge markdown. Add your tech stack as a bullet list, drop in screenshot URLs to auto-generate image embeds, and select a license from a dropdown to get a correctly worded License section (for the full legal text, pair this with the License Generator tool).

Everything runs client-side using the same Markdown renderer as the Markdown Editor tool. When you're happy with the result, hit Download to save it directly as README.md.

FAQ

Does this tool store or upload my project details?

No. All fields stay in your browser tab and are only used to generate the Markdown output locally. Nothing is sent to a server.

Can I edit the generated Markdown afterward?

Yes. The output is plain Markdown with no hidden markup — copy it, download it as README.md, and edit it in any text editor or directly on GitHub.

Does it include full license text?

No — it only adds a short "## License" section naming your chosen license. For the complete legal text, use the dedicated License Generator tool.

How are badges added?

Click any preset badge to toggle it into the top of your README. Each is a ready-made shields.io Markdown snippet.

What happens if I leave a field blank?

Blank sections are omitted entirely from the output rather than left as empty headings. Only the project name is required.