Upload README.md with huggingface_hub

README.md

@@ -16,72 +16,82 @@ Transform any YouTube video into a comprehensive, book-style summary using AI (G
 
 ---
 
-## Features
+## ⚠️ Important: Use Manual Transcript Tab
 
-- **🎬 YouTube URL Input**: Paste any YouTube URL to extract transcript automatically
-- **📝 Manual Transcript**: Paste transcripts manually as backup option
-- **🤖 AI-Powered Summaries**: Uses Groq's fast LLM (Llama 3.3 70B) for intelligent summarization
-- **📖 Book-Style Output**: Generates structured summaries with chapters, key concepts, and takeaways
-- **📥 Multiple Formats**: Download as PDF, Word document, or Markdown
-- **⏱️ Video Duration**: Shows speaking rate and reading time statistics
+**Hugging Face Spaces blocks YouTube access.** The YouTube URL tab will NOT work.
+
+### How to Use This App:
+
+1. **Open YouTube video** in another tab
+2. **Click "Show transcript"** button below the video
+3. **Copy the transcript text**
+4. **Go to "📝 Manual Transcript" tab** in this app
+5. **Paste the transcript** and click "Generate Summary"
 
 ---
 
-## How to Use
+## Step-by-Step Guide
+
+### Step 1: Get Transcript from YouTube
+
+1. Open any YouTube video (e.g., https://www.youtube.com/watch?v=example)
+2. Click the **"..." (more)** button below the video
+3. Click **"Show transcript"**
+4. Click anywhere in the transcript box
+5. Press **Ctrl+A** to select all
+6. Press **Ctrl+C** to copy
 
-### Option 1: YouTube URL (Primary Method)
-1. Go to **"YouTube URL"** tab
-2. Paste any YouTube URL
-3. Select transcript language (default: English)
-4. Click **"🚀 Generate Summary"**
+### Step 2: Generate Summary
 
-### Option 2: Manual Transcript (Backup)
-1. Go to **"📝 Manual Transcript"** tab
-2. Paste the transcript text
-3. Add video title (optional)
-4. Add video duration like `10:30` (optional)
+1. In this app, go to **"📝 Manual Transcript"** tab
+2. **Paste** the transcript (Ctrl+V)
+3. Add **video title** (optional)
+4. Add **video duration** like `10:30` (optional)
 5. Click **"🚀 Generate Summary from Transcript"**
 
+### Step 3: Download Results
+
+- **📄 PDF** - Formatted book-style summary
+- **📝 Word** - Editable document
+- **📋 Markdown** - For note-taking apps
+- **📜 Transcript** - Original text
+
 ---
 
 ## Required Setup (One-Time)
 
-### Step 1: Get Groq API Key
+### Get Groq API Key (FREE)
 
 1. Visit [console.groq.com](https://console.groq.com/)
 2. Sign up for **FREE** account
-3. Click **"API Keys"** in sidebar
-4. Click **"Create API Key"**
-5. Copy the key (starts with `gsk_`)
+3. Click **"API Keys"** → **"Create API Key"**
+4. Copy the key (starts with `gsk_`)
 
-### Step 2: Add Secret to HF Space
+### Add to Space Secrets
 
-1. Go to: [Space Settings](https://huggingface.co/spaces/simplytaps/Youtube-sum/settings)
+1. Go to [Space Settings](https://huggingface.co/spaces/simplytaps/Youtube-sum/settings)
 2. Scroll to **"Repository Secrets"**
-3. Click **"New Secret"**
-4. Enter:
+3. Add secret:
    - **Name**: `GROQ_API_KEY`
-   - **Value**: Your API key (e.g., `gsk_xxxxx...`)
-5. Click **"Add Secret"**
-6. **Restart** the Space (click "Factory reboot")
+   - **Value**: Your API key
+4. Click **"Add Secret"**
+5. **Restart** the Space
 
 ---
 
 ## Output Structure
 
-The generated summary includes:
-
 | Section | Description |
 |---------|-------------|
-| **Executive Overview** | High-level summary (2-3 paragraphs) |
-| **Introduction** | Background and context |
-| **Chapter-by-Chapter Summary** | Detailed breakdown |
-| **Key Concepts** | Important terms explained |
-| **Key Takeaways** | Numbered main insights |
-| **Memorable Quotations** | Notable quotes from video |
-| **Practical Applications** | How to apply the knowledge |
-| **Critical Analysis** | Strengths and limitations |
-| **Quick Bullet Summary** | TL;DR bullet points |
+| Executive Overview | High-level summary |
+| Introduction | Background and context |
+| Chapter-by-Chapter | Detailed breakdown |
+| Key Concepts | Important terms |
+| Key Takeaways | Main insights |
+| Memorable Quotations | Notable quotes |
+| Practical Applications | How to apply |
+| Critical Analysis | Strengths/limitations |
+| Quick Summary | TL;DR bullets |
 
 ---
 
@@ -89,46 +99,18 @@ The generated summary includes:
 
 | Problem | Solution |
 |---------|----------|
-| "API key error" | Add `GROQ_API_KEY` to Space secrets |
-| "Rate limit exceeded" | Get your own API key from console.groq.com |
-| "Transcript not found" | Video may not have captions; use Manual Transcript tab |
-| App not loading | Wait 1-2 minutes for Space to start |
+| "YouTube URL not working" | Use Manual Transcript tab instead |
+| "API key error" | Add GROQ_API_KEY to secrets |
+| "Rate limit exceeded" | Get your own API key |
+| App not loading | Wait 1-2 minutes for startup |
 
 ---
 
 ## Technical Stack
 
-| Component | Technology |
-|-----------|------------|
-| Frontend | Gradio 4.x |
-| LLM | Groq API (Llama 3.3 70B) |
-| Transcript | youtube-transcript-api |
-| Documents | python-docx, reportlab |
-
----
-
-## Files in This Space
-
-```
-├── Dockerfile           # Docker configuration
-├── README.md            # This file
-├── requirements.txt     # Python dependencies
-├── app.py               # Main Gradio application
-├── config.py            # Configuration
-├── groq_client.py       # Groq API client
-├── summarizer.py        # Summarization logic
-├── youtube_transcript.py # Transcript extraction
-├── youtube_summary.md   # LLM prompt template
-└── utils/
-    ├── __init__.py
-    └── statistics.py    # Statistics utilities
-```
-
----
-
-## License
-
-MIT License - Feel free to use and modify!
+- **Frontend**: Gradio 4.x
+- **LLM**: Groq API (Llama 3.3 70B)
+- **Documents**: python-docx, reportlab
 
 ---