✨ Automatically generate stunning README.md files for ANY GitHub repository ✨
_{🚫 Zero API costs • 💻 100% local • 🎨 5 beautiful themes • 🌍 Hindi support}

📺 Demo • ⚡ Install • 🚀 Usage • ✨ Features • 🎨 Themes • 🛠️ Stack

---

📺 Demo

⬆️ One command → Beautiful README in seconds ⬆️

---

⚡ Quick Install

# Step 1: Make sure Ollama is running
ollama serve

# Step 2: Install ReadmeAI
git clone https://github.com/chirag120670598-dotcom/my-app.git
cd my-app
pip install -r requirements.txt

# Step 3: Generate your first README!
python -m readmeai.main --style cool

🎯 That's it! No API keys. No registration. No cloud costs.

---

🚀 Usage

🎯 Basic Usage

# Generate README for current directory
python -m readmeai.main

# Specify a different directory
python -m readmeai.main --path /path/to/your/project

🎨 Theme Styles

# Default (clean & professional)
python -m readmeai.main --style default

# Cool (vibrant & modern)
python -m readmeai.main --style cool

# Professional (corporate-grade)
python -m readmeai.main --style professional

# Minimal (pure signal, no noise)
python -m readmeai.main --style minimal

# हिंदी (Hindi language)
python -m readmeai.main --style hindi

⚙️ Advanced Options

# Set a custom Ollama model
python -m readmeai.main --model llama3

# Exclude the "Made with ReadmeAI" badge
python -m readmeai.main --no-badge

# Show version
python -m readmeai.main --version

# List available AI models
python -m readmeai.main list-models

# Manage configuration
python -m readmeai.main config --show
python -m readmeai.main config --reset
python -m readmeai.main config          # Interactive mode

📤 Auto-Push to GitHub

# Generate AND push in one command!
python -m readmeai.main --push

# Or set it permanently:
python -m readmeai.main config
# → Set "auto_push" to true

---

✨ Features

Feature	Description	Status
🤖 AI-Powered	Uses Ollama (LLaMA 3) for smart descriptions	✅ Stable
🎨 5 Themes	Default, Minimal, Cool, Professional, Hindi	✅ Stable
🔍 Auto-Detect	Automatically detects your tech stack	✅ Stable
🏅 Smart Badges	Generates shields.io badges automatically	✅ Stable
📦 Zero API Costs	100% local execution via Ollama	✅ Free
🌍 Hindi Support	Generate READMEs in Hindi 🇮🇳	✅ Stable
📤 Auto Git Push	Commit & push to GitHub automatically	✅ Stable
🔄 README Updater	Update existing READMEs with AI	✅ Stable
⚙️ Config System	Persistent user configuration	✅ Stable
🧪 Test Suite	Comprehensive pytest coverage	✅ Stable

---

🎨 Themes Preview

Theme	Style	Best For
🌟 Default	Clean, professional, all sections	Most projects
🎯 Minimal	Just description, install, usage	Simple tools
🔥 Cool	Animated headers, emojis, collapsible sections	Viral repos, personal projects
💼 Professional	Corporate, changelog, security, architecture	Enterprise, team projects
🇮🇳 Hindi	Full Hindi language README	Indian developers

---

🛠️ Tech Stack

---

📁 Project Structure

📦 my-app/
├── 📂 readmeai/
│   ├── 📄 __init__.py          # Package init
│   ├── 📄 main.py              # CLI entry point (Click)
│   ├── 📄 scanner.py           # Repository scanner
│   ├── 📄 detector.py          # Tech stack detector
│   ├── 📄 builder.py           # README builder
│   ├── 📄 badge_gen.py         # shields.io badge generator
│   ├── 📄 themes.py            # 5 theme templates
│   ├── 📄 config.py            # Configuration system
│   ├── 📄 git_utils.py         # Git automation
│   ├── 📄 updater.py           # README updater
│   ├── 📄 ollama_client.py     # Ollama AI client
│   └── 📄 utils.py             # Terminal UI (Rich)
├── 📂 tests/
│   ├── 📄 __init__.py
│   ├── 📄 test_scanner.py      # Scanner tests
│   ├── 📄 test_detector.py     # Detector tests
│   └── 📄 test_builder.py      # Builder & badge tests
├── 📄 pyproject.toml           # Project config
├── 📄 setup.py                 # Setup script
├── 📄 requirements.txt         # Dependencies
├── 📄 .gitignore               # Git ignore
└── 📄 README.md                # You are here! 🎉

---

🧪 Testing

# Run all tests
pytest -v

# Run specific test file
pytest tests/test_detector.py -v

# Run with coverage
pytest --cov=readmeai tests/

---

🤝 Contributing

PRs are WELCOME! Let's make this the best README generator out there! 🚀

1. 🍴 Fork the repo
2. 🌿 Branch: git checkout -b feature/amazing-feature
3. 💾 Commit: git commit -m 'feat: add amazing feature'
4. 📤 Push: git push origin feature/amazing-feature
5. 🔀 Open a Pull Request

🌟 Ways to Contribute

• 🐛 Report bugs
• 💡 Suggest features
• 📝 Improve documentation
• 🌐 Add more themes
• 🔧 Fix issues
• ⭐ Star the repo!

---

📄 License

MIT License — Free to use, modify, and distribute.

Copyright (c) 2026 ReadmeAI

---

Made with ❤️ by Chirag Solanki
_{⚡ Generated by ReadmeAI — Meta, right? 😉}