README Gen ⚡

A modern, professional README generator that helps developers create comprehensive documentation for their projects in minutes. Built with Next.js 16, TypeScript, and Tailwind CSS.

🔗 Live Demo

https://v0-readme-gen.vercel.app

✨ Features

• URL Auto-Fill: Paste any GitHub repository URL to automatically fetch project name, description, tech stack, and more
• Comprehensive Form: Fill in all essential README sections including features, installation, usage, and environment variables
• Live Preview: See your README render in real-time as you type with a split-view layout
• Multiple Export Options: Copy to clipboard or download as README.md file
• Professional Templates: Generate well-structured, markdown-formatted documentation
• Badge Support: Add build status, version, license, and download badges automatically
• Responsive Design: Beautiful dark mode interface that works on all devices
• Floating Navbar: Modern UI with rounded corners and smooth animations
• Clear Form: Reset all fields instantly to start fresh

🛠 Tech Stack

• Framework: Next.js 16 with App Router
• Language: TypeScript
• Styling: Tailwind CSS v4
• UI Components: shadcn/ui with Radix UI primitives
• Forms: React Hook Form with Zod validation
• Icons: Lucide React
• Deployment: Vercel

📋 Prerequisites

• Node.js 18.x or higher
• npm, yarn, pnpm, or bun package manager

📦 Installation

Clone the repository:

git clone https://github.com/Rehanbuilds/readme-gen
cd readme-gen

Install dependencies:

npm install
# or
yarn install
# or
pnpm install
# or
bun install

▶️ Usage

Run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 in your browser to see the application.

Build for production:

npm run build
npm start

🎯 How to Use README Gen

1. Visit the Landing Page: Start at the homepage and click "Generate README"
2. Auto-Fill (Optional): Paste your GitHub repository URL to automatically populate fields
3. Fill the Form: Complete the sections you want to include in your README
   • Project details (name, description)
   • Features list
   • Tech stack selection
   • Installation and usage commands
   • Environment variables
   • Demo and screenshot URLs
   • Badges, roadmap, and contributing guidelines
4. Preview Live: Watch your README render in real-time on the right panel
5. Export: Copy to clipboard or download as README.md
6. Add to Repository: Follow the provided instructions to add the README to your project

🗺️ Roadmap

• Add support for more git hosting platforms (GitLab, Bitbucket)
• Template library with preset README styles
• Markdown editor with syntax highlighting
• Export to multiple formats (PDF, HTML)
• Custom badge generator
• Section reordering via drag-and-drop
• Save and load drafts

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

Steps to Contribute:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This project is free and open-sourced under the MIT License.

👤 Author

Rehan

• Website: rehanbuilds.xyz
• Twitter: @MRehan_5
• GitHub: @Rehanbuilds

🙏 Acknowledgments

• Built with v0.app by Vercel
• UI components from shadcn/ui
• GitHub API for repository data fetching

⭐ Show your support

Give a ⭐️ if this project helped you create better documentation!

---

© README Gen Built by Rehan, free and open sourced