Update README.md

README.md

@@ -8,3 +8,114 @@ pinned: false
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+# 🎯 Intelliverse — AI-Powered Recruitment Automation
+
+> **Hackathon Project** — Automated Resume Screening, Scoring & Interview Scheduling
+
+---
+
+## 🚀 What It Does
+
+1. **Upload** bulk PDF resumes  
+2. **AI Scores** each candidate 0-100 against your Job Description (using Google Gemini)  
+3. **Auto-Shortlist** candidates above your threshold  
+4. **Sends Emails** — interview invites to shortlisted, rejection emails to others — all automated
+
+---
+
+## 🛠️ Tech Stack
+
+| Layer | Tech |
+|-------|------|
+| Backend | Flask + SQLAlchemy (SQLite) |
+| AI Engine | Google Gemini 1.5 Flash/Pro |
+| PDF Parsing | PyMuPDF (fitz) |
+| Email | Python SMTP (Gmail) |
+| Frontend | Tailwind CSS + Chart.js |
+
+---
+
+## ⚡ Quick Start
+
+### 1. Clone & Install
+```bash
+git clone <your-repo>
+cd talentiq-ats
+pip install -r requirements.txt
+```
+
+### 2. Configure Environment
+```bash
+cp .env.example .env
+# Edit .env with your Gemini API key and Gmail credentials
+```
+
+### 3. Run
+```bash
+python app.py
+# Open http://localhost:5000
+```
+
+---
+
+## 📂 Project Structure
+
+```
+talentiq-ats/
+├── app.py                  # Flask routes & main logic
+├── utils/
+│   ├── ai_analyzer.py      # Gemini AI resume analysis
+│   ├── resume_parser.py    # PDF text extraction (PyMuPDF)
+│   ├── scheduler.py        # Email sending (SMTP)
+│   └── database.py         # SQLAlchemy models
+├── templates/
+│   ├── base.html           # Layout with navbar
+│   ├── index.html          # Landing page
+│   ├── upload.html         # Resume upload & screening
+│   ├── dashboard.html      # Analytics dashboard
+│   └── candidate_detail.html # Individual candidate view
+├── requirements.txt
+└── .env.example
+```
+
+---
+
+## 🔑 Environment Variables
+
+| Variable | Purpose |
+|----------|---------|
+| `GEMINI_API_KEY` | Google Gemini AI key |
+| `SECRET_KEY` | Flask session secret |
+| `SMTP_USER` | Gmail address for sending emails |
+| `SMTP_PASS` | Gmail App Password (not account password) |
+
+---
+
+## 📊 Features Overview
+
+- **Bulk PDF upload** with drag-and-drop
+- **Configurable score threshold** (slider UI)
+- **Interview scheduler** — set date, time, meeting link
+- **Auto email** — HTML-formatted invite & rejection emails
+- **Dashboard** with Doughnut & Bar charts
+- **Candidate profiles** with skill match/gap analysis
+- **Re-schedule** interviews from candidate detail page
+- **SQLite database** — full audit trail
+
+---
+
+## 🧠 AI Prompt Output (JSON)
+
+```json
+{
+  "name": "Priya Sharma",
+  "email": "priya@example.com",
+  "score": 84,
+  "reasoning": "Strong Python and ML background. Matches 7/9 required skills.",
+  "matching_skills": ["Python", "TensorFlow", "REST APIs"],
+  "missing_skills": ["Kubernetes", "AWS"],
+  "verdict": "Interview"
+}
+```
+