Update README with Hugging Face Space configuration

README.md

@@ -1,67 +1,71 @@
-# vBot - Voice Call Analysis API
-
-A FastAPI-based service for processing and analyzing voice call recordings.
-
-## API Endpoints
-
-### Process Call Recording
-```http
-POST /api/v1/process-call
-```
-
-#### Headers
-- `Authorization`: Bearer token for authentication
-
-#### Form Data
-- `file`: The audio file to process (supported formats: WAV, MP3)
-
-#### Response
-```json
-{
-  "id": "unique_id",
-  "text": "Transcribed text from the call",
-  "sentiment": "positive/negative/neutral",
-  "keywords": ["array", "of", "key", "terms"],
-  "timestamp": "2024-04-05T11:50:00Z"
-}
-```
-
-## Setup Instructions
-
-1. Clone the repository:
+---
+title: vBot - AI-Powered Call Analysis
+emoji: 📞
+colorFrom: blue
+colorTo: indigo
+sdk: gradio
+sdk_version: "4.19.2"
+app_file: main.py
+pinned: false
+---
+
+# vBot - AI-Powered Call Analysis System
+
+vBot is a multi-tenant system that provides AI-powered call analysis for Asterisk PBX systems. It processes phone conversations to provide transcription, summarization, and sentiment analysis using Hugging Face models.
+
+## Features
+
+- 🎯 Multi-tenant support with secure API keys
+- 🎙️ Real-time call processing
+- 📝 Speech-to-text transcription
+- 📋 Call summarization
+- 😊 Sentiment analysis
+- 🔒 Secure admin dashboard
+- 🔌 RESTful API
+
+## Quick Start
+
+1. **Deploy to Hugging Face Spaces**
+   - Click "Use this Space"
+   - Configure environment variables
+   - Deploy
+
+2. **Configure Environment Variables**
    ```bash
-   git clone https://huggingface.co/spaces/iajitpanday/vBot
+   JWT_SECRET=your-secure-secret-key
+   ADMIN_USERNAME=your-admin-username
+   ADMIN_PASSWORD=your-secure-password
+   DATABASE_URL=mysql+pymysql://username:password@host:port/database
    ```
 
-2. Create a virtual environment:
-   ```bash
-   python -m venv venv
-   source venv/bin/activate  # On Windows: venv\Scripts\activate
-   ```
+3. **Integration with Asterisk**
+   - Get your API key from the admin dashboard
+   - Configure your Asterisk dialplan
+   - Start processing calls
 
-3. Install dependencies:
-   ```bash
-   pip install -r requirements.txt
-   ```
+## Documentation
 
-4. Set up environment variables in `.env`:
-   ```
-   DATABASE_URL=your_database_url
-   JWT_SECRET=your_jwt_secret
-   HUGGINGFACE_API_KEY=your_api_key
-   ```
+For detailed documentation, please refer to our [User Manual](USER_MANUAL.md).
 
-5. Run the application:
-   ```bash
-   uvicorn main:app --host 0.0.0.0 --port 7860
-   ```
+## API Endpoints
+
+### Admin Endpoints
+- `POST /api/v1/token` - Get admin token
+- `POST /api/v1/customers/` - Create customer
+- `GET /api/v1/customers/` - List customers
+- `GET /api/v1/customers/{id}` - Get customer
+- `DELETE /api/v1/customers/{id}` - Delete customer
 
-## Environment Variables
+### Customer Endpoints
+- `POST /api/v1/process-call` - Process call
+- `GET /api/v1/calls/{id}` - List calls
 
-- `DATABASE_URL`: URL for the database connection
-- `JWT_SECRET`: Secret key for JWT token generation
-- `HUGGINGFACE_API_KEY`: API key for Hugging Face services
+## Support
+
+For support and troubleshooting, please refer to the [Troubleshooting Guide](USER_MANUAL.md#troubleshooting) in our user manual.
 
 ## License
 
-MIT License 
+MIT License
+
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference