Update README.md

README.md

@@ -1,45 +1,58 @@
-# README.md
+---
+title: Video to Audio Extractor
+emoji: 🎵
+colorFrom: blue
+colorTo: purple
+sdk: docker
+pinned: false
+license: mit
+---
+
 # Video to Audio Extractor
 
-A FastAPI-based web application that extracts audio from video files using FFmpeg. Designed to run on Hugging Face Spaces.
+A FastAPI-based web application that extracts audio from video files using FFmpeg. Convert your videos to audio in various formats with customizable quality settings.
 
-## Features
+## 🎯 Features
 
-- 🎥 Supports multiple video formats (MP4, AVI, MOV, MKV, WebM, FLV, WMV, M4V)
-- 🎵 Multiple audio output formats (MP3, AAC, WAV, FLAC, M4A, OGG)
-- 📊 Three quality levels (High, Medium, Low)
-- 🚀 Automatic handling of small files (< 10MB) with direct response
-- 📦 Background processing for large files with job status tracking
-- 🌐 Web interface and REST API
-- 🧹 Automatic cleanup of temporary files
+- 🎥 **Multiple video formats**: MP4, AVI, MOV, MKV, WebM, FLV, WMV, M4V
+- 🎵 **Multiple audio formats**: MP3, AAC, WAV, FLAC, M4A, OGG
+- 📊 **Quality levels**: High, Medium, Low
+- 🚀 **Smart processing**: Direct response for small files, background jobs for large files
+- 🌐 **Web interface**: User-friendly UI with real-time progress
+- 🔌 **REST API**: Full API access for programmatic use
+- 🧹 **Auto-cleanup**: Temporary files cleaned automatically
 
-## API Endpoints
+## 🖥️ Web Interface
 
-- `GET /` - Web interface for easy testing
-- `POST /extract-audio` - Extract audio from video
-- `GET /status/{job_id}` - Check background job status
-- `GET /download/{job_id}` - Download processed audio
-- `GET /api/info` - Get API information and supported formats
+Visit the Space URL to access the web interface where you can:
+- Upload video files via drag-and-drop or file selection
+- Choose output format and quality
+- Preview and download extracted audio
+- See real-time processing status
 
-## Usage
+## 📡 API Usage
 
-### Web Interface
-Simply visit the root URL and use the web form to upload a video file.
-
-### API Usage
+### Extract Audio (Direct Response)
+For files under 10MB, get immediate response:
 
 ```bash
-# Extract audio (small file - direct response)
-curl -X POST -F "video=@video.mp4" -F "output_format=mp3" -F "quality=high" \
-  https://your-space.hf.space/extract-audio \
-  --output extracted.mp3
+curl -X POST -F "video=@video.mp4" \
+     -F "output_format=mp3" \
+     -F "quality=high" \
+     https://your-space.hf.space/extract-audio \
+     --output audio.mp3
+```
 
-# Extract audio (large file - background job)
-# First, submit the job
-response=$(curl -X POST -F "video=@large_video.mp4" -F "output_format=mp3" \
-  https://your-space.hf.space/extract-audio)
+### Extract Audio (Background Job)
+For larger files:
 
-# Extract job_id from response
+```bash
+# Submit job
+response=$(curl -X POST -F "video=@large_video.mp4" \
+     -F "output_format=mp3" \
+     https://your-space.hf.space/extract-audio)
+
+# Get job ID
 job_id=$(echo $response | jq -r '.job_id')
 
 # Check status
@@ -49,64 +62,101 @@ curl https://your-space.hf.space/status/$job_id
 curl https://your-space.hf.space/download/$job_id --output audio.mp3
 ```
 
-### Python Client Example
+### Python Example
 
 ```python
 import requests
+import time
 
-# For small files
-with open('video.mp4', 'rb') as f:
-    files = {'video': f}
-    data = {'output_format': 'mp3', 'quality': 'high'}
-    response = requests.post('https://your-space.hf.space/extract-audio', 
-                           files=files, data=data)
+def extract_audio(video_path, output_format='mp3', quality='medium'):
+    url = 'https://your-space.hf.space/extract-audio'
+    
+    with open(video_path, 'rb') as f:
+        files = {'video': f}
+        data = {'output_format': output_format, 'quality': quality}
+        response = requests.post(url, files=files, data=data)
     
     if response.headers.get('content-type', '').startswith('audio/'):
-        # Direct file response
-        with open('output.mp3', 'wb') as out:
-            out.write(response.content)
+        # Direct response - save file
+        return response.content
     else:
-        # Job response for large files
+        # Background job - poll for completion
         job_data = response.json()
         job_id = job_data['job_id']
-        # Poll status and download when ready
+        
+        while True:
+            status = requests.get(f'{url.replace("/extract-audio", "")}/status/{job_id}').json()
+            if status['status'] == 'completed':
+                audio = requests.get(f'{url.replace("/extract-audio", "")}/download/{job_id}')
+                return audio.content
+            elif status['status'] == 'failed':
+                raise Exception(f"Processing failed: {status.get('error')}")
+            time.sleep(2)
+
+# Usage
+audio_data = extract_audio('my_video.mp4', 'mp3', 'high')
+with open('output.mp3', 'wb') as f:
+    f.write(audio_data)
 ```
 
-## Quality Settings
+## 🔧 API Endpoints
 
-- **High**: Best quality, larger file size
-- **Medium**: Balanced quality and file size (default)
-- **Low**: Smaller file size, acceptable quality
+- `GET /` - Web interface
+- `POST /extract-audio` - Extract audio from video
+- `GET /status/{job_id}` - Check job status
+- `GET /download/{job_id}` - Download processed audio
+- `GET /api/info` - API information and supported formats
 
-## Deployment on Hugging Face
+## 📊 Quality Settings
 
-1. Create a new Space on Hugging Face
-2. Choose "Docker" as the SDK
-3. Upload these files:
-   - `app.py`
-   - `requirements.txt`
-   - `Dockerfile`
-   - `README.md`
-4. The Space will automatically build and deploy
+| Quality | MP3 Bitrate | AAC Bitrate | Description |
+|---------|-------------|-------------|-------------|
+| High    | 320 kbps    | 256 kbps    | Best quality, larger files |
+| Medium  | 192 kbps    | 192 kbps    | Balanced (default) |
+| Low     | 128 kbps    | 128 kbps    | Smaller files |
 
-## Local Development
+## 🚀 Local Development
 
 ```bash
+# Clone the repository
+git clone <your-repo>
+cd video-to-audio-extractor
+
 # Install dependencies
 pip install -r requirements.txt
 
-# Make sure FFmpeg is installed
-# Ubuntu/Debian: sudo apt-get install ffmpeg
-# macOS: brew install ffmpeg
+# Install FFmpeg
+# Ubuntu/Debian
+sudo apt-get update && sudo apt-get install ffmpeg
+
+# macOS
+brew install ffmpeg
+
+# Windows
+# Download from https://ffmpeg.org/download.html
+
+# Run the application
+uvicorn app:app --reload --host 0.0.0.0 --port 7860
+```
+
+## 🐳 Docker Deployment
+
+```bash
+# Build the image
+docker build -t video-to-audio-extractor .
 
-# Run the app
-uvicorn app:app --reload --port 7860
+# Run the container
+docker run -p 7860:7860 video-to-audio-extractor
 ```
 
-## Environment Variables
+## 📝 License
+
+This project is licensed under the MIT License.
+
+## 🤝 Contributing
 
-No environment variables required! The app uses temporary file storage and cleans up automatically.
+Contributions are welcome! Please feel free to submit a Pull Request.
 
-## License
+## 🐛 Issues
 
-MIT License
+If you encounter any issues or have feature requests, please file them in the [Issues](https://huggingface.co/spaces/your-username/your-space-name/discussions) section.