README Generator
Create a GitHub README with badges, sections, and templates, with a live Markdown preview and download.
📋 Project Info
📝 Sections
🏷️ Badges
👁️ Preview
# Project Name
[](https://opensource.org/licenses/MIT)
A brief description of your project
## ✨ Features
- Feature 1
- Feature 2
- Feature 3
## 📦 Installation
```bash
npm install project name
```
Or with yarn:
```bash
yarn add project name
```
## 🚀 Usage
```javascript
import { example } from 'project name';
// Your code here
example();
```
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
1. Fork the project
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## 📝 License
Copyright © 2026 [Your Name](https://github.com/username).
This project is [MIT](./LICENSE) licensed.
---
Made with ❤️Features
- Visual README.md builder
- Drag-and-drop sections (Title, Badges, Install, Usage)
- Preset templates (Library, App, backend)
- Live Markdown preview
- Emoji and Badge picker
Common Use Cases
- Creating a professional landing page for your repo
- Documenting API usage
- Providing installation instructions
README.md
The README is the first thing people see when they visit your repository. A good README explains what the project does, why it is useful, and how to get started.
Examples
Valid - Header
# Project Name
> A short description. Valid - Badges
Frequently Asked Questions
What format is it?
Usually Markdown (.md), but reStructuredText (.rst) is also supported by GitHub.
Are badges dynamic?
Yes, if you use a service like Shields.io, they can show live build status or version numbers.
💡 Tips
- Include screenshots or GIFs! They make a huge difference in engagement.