Transform any GitHub repository into professional documentation instantly — or build a standout GitHub profile with handcrafted templates. Smart README analyzes your codebase and generates comprehensive, well-structured READMEs using Google's Gemini AI.
🔗 Live Demo: https://smart-readme.vercel.app
- ✨ Features
- 📸 Screenshots
- 🛠️ Tech Stack
- ⚙️ Getting Started
- 🚀 Usage
- 📁 Project Structure
- 🎨 Profile Templates
- 🤝 Contributing
- 📄 License
- 🤖 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
- 💾 Copy to Clipboard — Grab your README with one click
- 🧑💻 5 Handcrafted Templates — Obsidian, Dawn, Minimal, Aurora, and Terminal styles
- 👀 Live Preview — Preview updates instantly as you type your details
- 🏷️ GitHub Stats & Badges — Auto-included stats cards, language charts, and social badges
- 📋 One-Click Copy — Copy the finished README and paste it into your GitHub profile repo
- 🌧️ Cinematic Dark UI — Obsidian theme with animated code rain background
- ⚡ Splash Screen — Scanning animation on load
- 📊 Repo Stats Odometer — Animated stars and forks counter after generation
| Layer | Technology |
|---|---|
| Framework | Next.js 15 (App Router) |
| Language | TypeScript |
| Styling | Tailwind CSS |
| Animations | Framer Motion |
| AI Model | Google Gemini 2.5 Flash |
| Markdown | react-markdown + remark-gfm |
| 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 in the root:
GEMINI_API_KEY=your_gemini_api_key_herenpm run dev- Click Repository README on the landing page
- 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 your README
- Click Profile README on the landing page
- Hover over templates to preview styles — click one to select it
- Fill in your details (name, bio, skills, projects, social links)
- Click Generate README
- Copy and paste into your
<username>/<username>GitHub repository'sREADME.md
smart-readme/
├── app/
│ ├── api/
│ │ ├── generate/ # Gemini AI generation route
│ │ └── github/ # GitHub repo data fetcher
│ ├── globals.css
│ ├── layout.tsx
│ └── page.tsx # Main app (landing, repo, profile modes)
├── components/
│ ├── CodeRain.tsx # Animated code rain background
│ ├── LoadingOverlay.tsx # Splash screen animation
│ ├── OdometerStats.tsx # Animated stars/forks counter
│ └── Toast.tsx # Copy confirmation toast
└── public/
└── icon.png
| Template | Style | Accent |
|---|---|---|
| 🌑 Obsidian | Dark, cinematic, dev-forward | Cyan |
| 🌅 Dawn | Warm, clean, approachable | Orange |
| ◻ Minimal | Type-first, no noise | Slate |
| 🌌 Aurora | Purple & teal, expressive | Violet |
| ⌨ Terminal | Green-on-black, hacker chic | Green |
- 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!