README.md Generator
Privacy First: Your files are processed securely. Whenever possible, processing happens in your browser and files are never stored on our servers.
Create a polished GitHub README in minutes. Fill in your project name, tagline, description, GitHub username and repo name, programming language, and license. Toggle individual sections on or off: title & banner, badges (language, license, stars, issues), description, features list, installation instructions, usage with code blocks, environment variables, API reference template, contributing guidelines, license, and contact. The live Preview tab renders the Markdown in real time using the marked library. Badges are generated using shields.io. Add features as a bullet list - add and remove items dynamically. Copy the raw Markdown or download as README.md. All generation runs in your browser - no data is uploaded.
How to Use
- 1Fill in your project name, GitHub username, repo name, and description in the left panel
- 2Toggle sections on/off using the checkboxes (e.g. disable API Reference if not needed)
- 3Add features to the bullet list using the feature input - press Enter to add each one
- 4Click the Preview tab to see the rendered Markdown in real time
- 5Click 'README.md' to download or 'Copy' to copy the raw Markdown
Features
- 11 toggleable sections: title, badges, description, features, install, usage, env vars, API, contributing, license, contact
- Live Markdown preview using GitHub Flavored Markdown (GFM)
- Shields.io badges: language, license, GitHub stars, and issues
- Dynamic features list - add and remove bullet points
- Badge auto-generation based on GitHub username and repo name
- Multiple license options: MIT, Apache 2.0, GPL v3, BSD, ISC, Mozilla, Unlicense
- Copy raw Markdown or download as README.md
- 100% browser-based
Frequently Asked Questions
Community Feedback
Like
Total Rating
No ratings yetReviews
No reviews yet. Be the first!
Rate & Review
Was this tool helpful?
Rate this tool:
Write a Review