What sections does it generate?

It produces a title with badges, a description, a table of contents, features, installation, usage, tech stack, contributing, and license sections. You can leave optional fields blank to omit a section.

Where do the badges come from?

Badges are generated as shields.io image URLs built from your repo path, so the license, last-commit, and stars badges render live from GitHub once the README is in your public repository.

Can I use this for a non-JavaScript project?

Yes. The install and run commands are free text, so you can put pip install, cargo build, go run, or any commands. The tech stack tags are just labels and work for any language or framework.

Does it support a table of contents?

Yes. A linked table of contents is generated using GitHub's heading-anchor convention, where spaces become hyphens and text is lowercased, so the links jump to the right sections.

Is my project data uploaded?

No. The README is assembled entirely in your browser from the fields you type. Nothing is sent to a server, so it is safe to use for private or unreleased projects.

README.md Generator — Gera Tools

Email me this result

Get this tool's output sent to your inbox, plus one useful tool a week. No spam, unsubscribe any time.

A good README is the front door of any repository. This generator turns a handful of fields — name, description, stack, and key commands — into a complete, well-structured README.md with badges, a table of contents, and the standard installation, usage, contributing, and license sections.

How it works

The tool composes Markdown from your inputs using GitHub conventions:

The title line is followed by shields.io badge URLs built from your owner/repo path, so license, last-commit, and stars badges render live.
A table of contents is generated by slugifying each heading — lowercasing the text and replacing spaces with hyphens — to match GitHub’s automatic anchors.
Features, install, usage, and tech-stack sections are filled from your lists, and empty sections are skipped so the output stays clean.

Tips and notes

Keep the description to one sentence; it doubles as your repo’s social preview text.
Use fenced code blocks for commands so they copy cleanly — the generator wraps install and usage commands for you.
Tech-stack tags render as inline badges; keep them short like TypeScript, Next.js, PostgreSQL.
After pasting, verify the table-of-contents links resolve, since custom emoji or punctuation in headings changes the anchor.