Transform any GitHub repository into professional documentation instantly. Smart README analyzes your codebase and generates comprehensive, well-structured READMEs using Google's Gemini AI.
🔗 Live Demo: https://smart-readme.vercel.app
- 🤖 AI-Powered Generation — Gemini 2.5 Flash analyzes your repo and writes accurate, detailed documentation
- 🎨 Tone Control — Choose from Professional, Beginner-friendly, Funny, or Corporate styles
- ✏️ Special Instructions — Add custom context like contributor names, university project details, or specific sections
- 😊 Emoji Toggle — Enable or disable emojis with one click to match your project's vibe
- 🖊️ Live Editor — Edit the generated README with syntax highlighting in real-time
- 👁️ Instant Preview — See the rendered markdown beside your editor as you type
- 💾 Export Options — Copy to clipboard or download as a .md file
- 🌧️ Obsidian UI — Cinematic dark theme with animated code rain background
- Framework: Next.js 15 (App Router)
- Language: TypeScript
- Styling: Tailwind CSS
- AI Model: Google Gemini 2.5 Flash
- Analytics: Vercel Analytics
- Deployment: Vercel
- Node.js (LTS)
- A Google Gemini API key — get one free at aistudio.google.com
git clone https://github.com/rauf17/smart-readme.git
cd smart-readme
npm installCreate a .env.local file:
GEMINI_API_KEY=your_gemini_api_key_here
npm run dev- Paste any public GitHub repository URL into the search bar
- Select your preferred tone (Professional, Funny, etc.)
- Optionally toggle emojis on/off
- Add special instructions if needed (contributor names, project context)
- Click Generate
- Edit the result in the live editor
- Copy or download your README
smart-readme/
├── app/
│ ├── api/generate/ # Gemini API route
│ ├── layout.tsx
│ └── page.tsx
├── components/
│ ├── CodeRain.tsx # Animated background
│ ├── Editor.tsx # Syntax-highlighted editor
│ └── Toolbar.tsx # Emoji toggle + instructions
├── lib/
│ └── github.ts # GitHub repo fetcher
└── public/
└── screenshots/ # App screenshots
- Fork the repo
- Create a branch:
git checkout -b feat/your-feature - Commit:
git commit -m "feat: add your feature" - Push:
git push origin feat/your-feature - Open a Pull Request
MIT License — free to use and modify.
Built by rauf17
⭐ Star this repo if it saved you time!