Skip to content
Free · No signup · Instant

README Generator

Pick your project type. Fill in the sections. Get a professional README.md in minutes — not hours.

8 project typesREADME ScoreBadge builderNo signup

How it works

Three steps. Five seconds.

1

Pick Your Project Type

Select from 8 types to get smart defaults and the right sections pre-loaded.

2

Fill In & Customize

Edit sections, add badges, drag to reorder. Watch your README Score climb.

3

Copy or Download

One click to copy markdown or download as README.md. Paste into your repo.

What are you building?

Pick a type to get smart defaults

Why This README Generator

Every other tool uses the same sidebar-form-preview pattern. We built something better.

01🎯

Project-Type Awareness

8 project types (library, CLI, web app, API, profile, internal, hackathon, monorepo) with smart defaults. Pick your type and get the right sections pre-loaded.

Each project type comes with a curated set of sections, smart placeholder content, and type-specific badge suggestions. A library gets install commands and API reference; a hackathon project gets a quick demo link and team credits.

02📊

README Score — 0 to 100

A real-time score that gamifies completeness. Structure (40pts), Content (40pts), Polish (20pts). Get suggestions to improve as you go.

The score algorithm checks for title, installation, usage, badges, features, license, contributing guidelines, and more. Color-coded from red (0-30) through amber, blue, to green (81-100). Aim for 80+ for a professional README.

03🏷️

Visual Badge Builder

Browse 20+ shields.io badges by category. Build, coverage, version, license, downloads, language — pick and click. Auto-fills your owner/repo.

No more copy-pasting shield URLs from documentation. Select badges from a visual picker, see live previews, and add custom badges with any shields.io URL. All badge URLs auto-populate with your GitHub username and repo name.

04🔀

Drag-and-Drop Section Editor

24 section types organized into essential, recommended, and optional categories. Drag to reorder, collapse to declutter, delete what you don't need.

Each section has a type-specific editor: text fields, badge pickers, list builders, key-value tables, license selectors, and demo link inputs. The block-based approach lets you see your entire README structure at a glance.

Frequently asked questions

Everything you need to know.

1

Is this README generator free?

Yes, completely free with no signup, no account, and no limits. Generate as many READMEs as you want. Your content stays in your browser via local storage.

Your README deserves better than a template

Smart defaults, visual badges, drag-and-drop sections. Build it in minutes.