README Generator

Fill in a short form and get a clean README with badges, a table of contents and every section a project needs.

Build a README

Project name Tagline

Description

Features, one per line

Install Package name

Usage example Language

Configuration, key = value per line

Contributing note License

Sections: 0 · Words: 0 · Lines: 0

Every section you fill in is added to the README and to the table of contents.

Badges use shields.io URLs with your project name and license, so they resolve as soon as the repository is public.

Enter the project name, tagline, description and one feature per line.
Pick the install method, language, license and the badges you want at the top.
Press Generate README and copy the Markdown into a README.md file in your repository.

Common questions about the free online readme generator.

Fill in the project name, description, features, install command and usage example, then press Generate README.

It adds a title, badges, description, features, installation, usage, configuration, contributing, license and a table of contents.

Only the sections that contain text get a heading, and each one is linked from the table of contents with a matching anchor.

Yes. Pick npm, yarn, pnpm, pip, composer or Go and the installation block is written with the matching command.

Badges are shields.io links built from your project name and license, so they start working once the repository is public.

Put one key per line in the form key = description and the tool builds a two column Markdown table from those lines.

Yes. The output is plain Markdown, so you can paste it into your editor and change any wording you like.

No. It only uses the text you type, needs no sign in and never contacts your source control provider.

Yes. The generator is free, runs in the browser and has no limits on how many README files you create.

Last updated: October 10, 2026