What format is the output?

Standard GitHub-flavoured Markdown. Copy the output and paste it into a README.md file in your repository.

Can I add a language badge?

Yes. Enter a language name (e.g. TypeScript) in the Badge Language field and a shields.io badge is added automatically.

Is my data sent anywhere?

No. The README is generated entirely in your browser. Nothing is sent to a server.

Developer Tools

README Generator — Build a GitHub README in Seconds

🔒 Runs in your browser

Fill in your project name, description, features, installation steps, and licence — and get a clean, ready-to-paste README.md instantly. No account, no upload — runs entirely in your browser.

How to use this tool

Fill in your project name and description.
Add sections for installation, usage, and license.
Copy the generated Markdown README.

Project Name

Badge Language

Description

Features

Installation

Usage

License

Frequently Asked Questions

What format is the output?: Standard GitHub-flavoured Markdown. Copy the output and paste it into a README.md file in your repository.
Can I add a language badge?: Yes. Enter a language name (e.g. TypeScript) in the Badge Language field and a shields.io badge is added automatically.
Is my data sent anywhere?: No. The README is generated entirely in your browser. Nothing is sent to a server.

More free toolsSee all 162 →

Merge PDFs Compress Image JSON Formatter Password Generator VAT Calculator QR Code Generator