Update README.md

README.md

@@ -6,79 +6,53 @@ colorFrom: indigo
 colorTo: purple
 sdk_version: 1.46.0
 ---
-# 🦇 BatAnki – AI Flashcard Generator
+# 🦇 BatAnki – AI Flashcard Engine for PDF / Image / Audio / YouTube / Text
 
-BatAnki is an AI-powered flashcard generator for medical learners. Inspired by Batman, built for speed. Runs on [Hugging Face Spaces](https://huggingface.co/spaces) using `streamlit`.
+BatAnki is an offline, fully open-source, AI-powered flashcard app designed for students, medicos, and power learners. Built for Hugging Face Spaces, no API keys required.
 
 ---
 
-## ✅ Features
-
-- 📄 PDF → Flashcards (with OCR fallback)
-- 🖼️ Image → Text → Flashcards (via EasyOCR)
-- 🎧 Audio → Transcription → Flashcards (via Whisper)
-- 🧠 AI Flashcard Generator (Q&A, Cloze, MCQ via T5)
-- 💾 Export to `.apkg` (Anki deck)
-- 🦇 Batman/Dark theme UI
-- 🧪 Smart tagging and chunking
-- ✅ 100% free (no OpenAI API, no paid keys)
-
----
-
-## 🚀 Deployment (Hugging Face)
-
-### Step 1: Create Space
-
-1. Go to: [https://huggingface.co/spaces](https://huggingface.co/spaces)
-2. Click **Create new Space**
-3. Name it something like `batanki-app`
-4. Choose **"Streamlit"**
-5. Choose **"Public"** (or Private if you have Pro)
-
----
-
-### Step 2: Upload Files
-
-Upload the following into your Space:
-- `app.py`
-- `config.py`
-- `requirements.txt`
-- (Optional) `README.md`
+### ✅ Features (All Green Table Items Supported)
+- 📄 Upload & process **PDF, Image, Audio, YouTube, Text (.txt/.docx)**  
+- 🔠 Extract text using **OCR**, **Whisper**, or **PyMuPDF**
+- 🧠 Generate flashcards using **T5** or **BioGPT**
+- 💡 Supports **Q&A, Cloze, MCQ, and Reverse cards**
+- 🏷️ Tag flashcards manually
+- 💾 Export to **Anki (.apkg)** and **CSV**
+- 🧾 Inline preview & edit of each card
+- 🎨 Light/Dark themes with Batman-style layout
+- ⚙️ 100% deployable without any paid APIs
 
 ---
 
-### Step 3: Let Hugging Face Build
-
-- It will automatically install all packages from `requirements.txt`
-- Wait for build to complete (~2–4 minutes)
-- The app will launch at `https://<your-username>.huggingface.space`
-
----
-
-## 🧠 Model Details
-
-- Flashcard AI: `t5-base` (can be swapped with `BioGPT` or `medalpaca` for more clinical reasoning)
-- OCR: `PyMuPDF` + `pytesseract` + `easyocr`
-- Audio: `openai/whisper` (base model)
+### 🧠 Models Used
+- `t5-base` (general QA generation)
+- `microsoft/BioGPT` (medical/scientific Q&A)
+- `openai/whisper` (audio transcription)
+- `easyocr` + `pytesseract` (OCR engine)
 
 ---
 
-## 📦 Output
-
-- You can export your flashcards as `.apkg` (for Anki)
-- Flashcards support Q&A + answer-side reveal + optional cloze
-
----
-
-## 💡 Notes
-
-- No external API needed
-- Fully runs within Hugging Face (free tier)
-- No login/save yet (you can add SQLite/Firestore later)
+### 💻 Usage Instructions
+1. 📁 Upload a file (PDF, Image, Audio, Text) or paste a YouTube link
+2. 🎯 Choose the card types you want (Q&A, Cloze, MCQ, Reverse)
+3. 🚀 Click **Extract Text**, then **Generate Flashcards**
+4. ✍️ Edit, tag, and preview each card
+5. ⬇️ Export as `.apkg` or `.csv`
 
 ---
 
-## ⚡ Credits
+### 🛠 Requirements
 
-- Built by Dr. Pavan Reddy (idea)
-- Engineered by OpenAI ChatGPT-4
+```bash
+streamlit
+transformers
+torch
+genanki
+easyocr
+PyMuPDF
+pytesseract
+whisper
+yt-dlp
+python-docx
+Pillow