Every time I start a new project, I dread the same thing: writing the README.
Not because it's hard — but because it's tedious. You Google "readme template", copy some random markdown, spend 20 minutes tweaking it, and it still looks mediocre.
So I built a tool to fix that.
🔗 README Generator
It's a free, open-source tool that lets you build a professional README.md in minutes — with a live preview.
How it works
- Toggle sections you need (Title, Badges, Features, Installation, API, etc.)
- Fill in your details using simple form fields
- See the live preview update in real-time
-
Copy the markdown or download as
.mdfile
That's it. No sign-up. No email required. No "premium tier".
Why I built it
I was tired of:
- Googling "readme template github" for the 100th time
- Copy-pasting from old projects and forgetting to update things
- Spending more time on the README than on actual code
So I made a visual builder where you just fill in the blanks.
Tech stack
The entire app is a single HTML file. No React, no Next.js, no npm install. Just:
- Vanilla HTML/CSS/JS
- marked.js for markdown rendering
- Deployed on Vercel (free tier)
Features
- ✅ 12 toggleable sections (Title, Badges, Description, Features, Tech Stack, Installation, Usage, Env Variables, API Reference, Contributing, License, Author)
- ✅ Live markdown preview
- ✅ Copy to clipboard with one click
- ✅ Download as .md file
- ✅ Dark mode UI
- ✅ Fully responsive
- ✅ Works offline after first load
It's open source
The full source code is on GitHub:
Feel free to fork it, improve it, or steal ideas from it. PRs welcome!
What's next
I'm thinking about adding:
- Drag & drop to reorder sections
- More badge presets (npm version, downloads, coverage)
- Template presets (library, CLI tool, web app)
- Export as PDF
What features would you add? Drop a comment below 👇
🔗 Try it: readme-generator-xi-one.vercel.app
⭐ Star it: github.com/trobasuj-cpu/readme-generator
Top comments (0)