README Generator — Live Preview, 7 Templates, Badge Builder
7 templates · Live preview · Badge builder · Tech stack · GitHub stats · Export .md
Generate a professional README.md for your GitHub project in minutes — no markdown knowledge needed. Pick from 7 project templates (NPM Library, CLI Tool, REST API, Mobile App, SaaS, Game, GitHub Profile), fill in your project details, add shields.io badges, build a tech stack grid, embed GitHub stats cards, and download the .md file. Live GitHub-flavored preview updates as you type. Markdown linter catches common issues before you publish.
my-awesome-project
A short description of your project.
📋 Table of Contents
📖 About
A short description of your project.
✨ Features
⚙️ Installation
npm install my-awesome-project
🚀 Usage
import { myFunc } from 'my-awesome-project';const result = myFunc({ option: 'value' });
console.log(result);
🤝 Contributing
Contributions are always welcome!
See CONTRIBUTING.md for ways to get started.
git checkout -b feature/amazing-feature)git commit -m 'Add amazing feature')git push origin feature/amazing-feature)⚖️ License
Distributed under the MIT License. See LICENSE for more information.
Frequently Asked Questions
What is a README.md file?
README.md is the documentation file shown on GitHub repository pages. The .md extension means Markdown format — a lightweight markup language that GitHub renders as styled HTML. A good README explains what your project does, how to install and use it, and how others can contribute. It is the first impression of any open-source project.
Which project template should I choose?
Choose NPM Library for JavaScript/Python packages, CLI Tool for command-line apps, REST API for backend services, Mobile App for iOS/Android/Flutter projects, SaaS/Web App for full-stack applications, Game for interactive projects, and GitHub Profile for your personal profile README. Each template pre-selects the most relevant sections for that project type.
How does the live preview work?
The right panel shows a GitHub-style rendered Markdown preview that updates 200ms after you stop typing. It renders headings, bold/italic text, code blocks, inline code, links, badge images, blockquotes, and horizontal rules. This gives you an accurate visual representation of how your README will look on GitHub.
What is the Markdown linter feature?
The linter checks your README for common issues as you type — missing project name or description, empty installation or usage sections, screenshots section enabled without an image URL, placeholder username not replaced, and extremely long README length. Errors appear in red, warnings in yellow, and info messages in blue above the preview panel.
How do I reorder sections in my README?
Go to the Sections tab in the left panel. Drag rows using the ⠿ handle to reorder them. Use the ↑/↓ arrow buttons for keyboard-friendly ordering. Toggle the checkbox to include or exclude any section. The README preview updates immediately when you reorder or toggle sections.
Can I use this for a GitHub profile README?
Yes — select the "GitHub Profile" template which enables the About, Tech Stack, GitHub Stats, and Contact sections. Enter your GitHub username in the Extras tab to generate stats cards (commits, stars, streak, top languages). Create a repository named exactly the same as your GitHub username, then paste the generated README.md content there.