A README generator creates the structured documentation file that appears on your GitHub repository's homepage — helping users understand your project, install it, and contribute to it. Fill in the form below and get a professional README.md with badges, table of contents, and properly formatted sections.
Quick Templates
Project Info
Badges
No badges yet.
Features
No features yet.
Technologies / Stack
Section Toggles
Live Preview
Export README
How to Use the README Generator
A well-written README is often the difference between a project getting starred on GitHub and being ignored. This free README generator creates structured, professional README.md files with all the sections developers expect — badges, installation steps, usage examples, and contribution guidelines — without writing a single line of Markdown from scratch.
Step 1: Choose a Template
Start with one of the five templates: Open Source Library, CLI Tool, API Project, Full Stack App, or Documentation. Each template pre-fills the sections and placeholder text appropriate for that project type. You can customize any field after loading a template — templates just give you a head start with realistic content.
Step 2: Fill In Project Details
Enter your project name, description, author username, demo URL, and preferred open source license. Add the installation command (e.g., npm install your-package) and a code usage example. The live preview on the right updates as you type, so you can see exactly how the README will look.
Step 3: Add Badges
Badges are the colorful status indicators at the top of many README files. Click the preset buttons to add common badges like Build Status, npm Version, License, or Coverage. Or click "Add Badge" to create a custom badge with your own label, value, and color. The generator uses the shields.io badge format, which is compatible with GitHub.
Step 4: Add Features and Technologies
List your project's key features using the Features section — each feature becomes a bullet point in the README. Add your technology stack as tags by typing a technology name and pressing Enter. These appear as a comma-separated list in the Technologies section.
Step 5: Toggle Sections and Export
Use the Section Toggles to include or exclude Table of Contents, Installation, Usage, Features, Contributing, and License sections. When ready, click Copy Markdown to copy to your clipboard, or Download README.md to save the file. Drop it in your project's root directory and push to GitHub — your project will look professional immediately.
FAQ
Is this README generator completely free?
Yes, entirely free with no limits or account required. Generate as many README files as you need. Everything runs locally in your browser — nothing is sent to any server.
Is my project information safe when using this tool?
Absolutely. All processing happens in your browser using client-side JavaScript. Your project name, description, and other details are never uploaded or stored anywhere. They stay on your device.
What Markdown badges can I add?
You can add shields.io-style badges for build status (GitHub Actions), npm version, license, coverage percentage, and download counts. Each badge has a label, value, color, and optional link URL. The tool generates the correct Markdown badge syntax automatically.
Does the README generator support GitHub Flavored Markdown?
Yes. The generated Markdown uses GitHub Flavored Markdown conventions including fenced code blocks, tables, and task lists. The live preview renders the Markdown using standard HTML so you can see exactly how it will look on GitHub.
How do I add a table of contents?
Toggle the Table of Contents option in the Section Toggles panel. The table of contents is automatically generated from your enabled sections — it creates anchor links to Installation, Usage, Features, API Reference, Contributing, and License sections as appropriate.
What are the README templates?
Templates include Open Source Library (for npm packages and general libraries), CLI Tool (for command-line utilities), API Project (for REST or GraphQL APIs), Full Stack App (for web applications), and Documentation (for docs-only repositories). Each pre-fills sections with placeholder content relevant to that project type.
Can I download the generated README.md file?
Yes. Click the Download README.md button to save the file directly to your computer with the correct .md extension. You can also copy the Markdown to the clipboard and paste it directly into your repository.