Upload README.md with huggingface_hub

README.md

@@ -4,26 +4,90 @@ emoji: 🎙️
 colorFrom: blue
 colorTo: purple
 sdk: gradio
-sdk_version: 3.50.2
+sdk_version: 4.19.2
 app_file: gradio_app.py
 pinned: false
 ---
 
-# Real-time Speech Transcription with FastRTC and Whisper
+# Real-time Transcription with FastRTC
 
-This application provides real-time speech transcription using FastRTC for audio streaming and Whisper for speech recognition.
+This project implements real-time audio transcription using FastRTC and Gradio, deployed on Hugging Face Spaces.
 
 ## Features
-- Real-time audio streaming
+
+- Real-time audio transcription
 - Voice Activity Detection (VAD)
-- Multi-language support
-- Low latency transcription
-
-## Usage
-1. Click the microphone button to start recording
-2. Speak into your microphone
-3. See your speech transcribed in real-time
-4. Click the microphone button again to stop recording
+- Web-based interface using Gradio
+- Deployed on Hugging Face Spaces
+
+## Prerequisites
+
+- Python 3.8 or higher
+- Hugging Face account and token
+- Git
+
+## Setup
+
+1. Clone the repository:
+```bash
+git clone <your-repo-url>
+cd realtime-transcription-fastrtc
+```
+
+2. Create a `.env` file with your Hugging Face credentials:
+```
+HUGGINGFACE_TOKEN=your_token_here
+HUGGINGFACE_USERNAME=your_username_here
+```
+
+3. Install dependencies:
+```bash
+pip install -r requirements.txt
+```
+
+## Deployment
+
+1. Make sure you have set up your `.env` file with the required credentials.
+
+2. Run the deployment script:
+```bash
+python deploy.py
+```
+
+The script will:
+- Check for required environment variables
+- Install dependencies
+- Log in to Hugging Face
+- Create a new Space
+- Deploy your application
+
+3. Once deployed, your application will be available at:
+```
+https://huggingface.co/spaces/<your-username>/realtime-transcription
+```
+
+## Local Development
+
+To run the application locally:
+
+```bash
+python app.py
+```
+
+The application will be available at `http://localhost:7860`
+
+## Troubleshooting
+
+If you encounter any issues during deployment:
+
+1. Check that your Hugging Face token is valid and has the necessary permissions
+2. Ensure all dependencies are installed correctly
+3. Verify that your `.env` file contains the correct credentials
+4. Check the Hugging Face Spaces logs for any deployment errors
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
 
 ## Technical Details
 - Uses FastRTC for WebRTC streaming