Consolidate all documentation into README.md

README.md

@@ -9,75 +9,274 @@ app_file: main.py
 pinned: false
 ---
 
-# vBot - AI-Powered Call Analysis System
+# vBot - Intelligent 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.
+vBot is an intelligent call analysis system that processes, transcribes, and analyzes phone calls using AI. It provides real-time insights, sentiment analysis, and call summaries through a modern API-based architecture.
 
 ## 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
+- Real-time call processing and analysis
+- AI-powered transcription and summarization
+- Sentiment analysis and keyword extraction
+- Modern admin interface for customer management
+- Secure API-based architecture
+- Webhook support for customer integration
+- Detailed call analytics and reporting
+
+## System Requirements
+
+- Python 3.8 or higher
+- MySQL 5.7 or higher
+- Asterisk PBX system
+- Hugging Face Space (for deployment)
+- Customer's web server (for webhook handling)
 
 ## Quick Start
 
-1. **Deploy to Hugging Face Spaces**
-   - Click "Use this Space"
-   - Configure environment variables
-   - Deploy
+1. Clone the repository:
+   ```bash
+   git clone https://huggingface.co/spaces/iajitpanday/vBot
+   cd vBot
+   ```
+
+2. Set up virtual environment:
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   ```
+
+3. Install dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+4. Configure environment variables:
+   ```bash
+   cp .env.example .env
+   # Edit .env with your configuration
+   ```
+
+5. Run the application:
+   ```bash
+   python main.py
+   ```
+
+## Admin Setup
+
+1. Access the admin interface:
+   - URL: `https://your-domain.com/admin`
+   - Default credentials: admin/admin (change immediately)
+
+2. Create your first customer:
+   - Click "Add Customer"
+   - Fill in customer details:
+     - Name
+     - Company Name
+     - Email
+   - System will generate a unique API key
+
+3. Configure customer webhook:
+   - Provide webhook URL where call results will be sent
+   - Optional: Set webhook secret for additional security
+
+## Asterisk Configuration
+
+1. Configure Asterisk dialplan:
+   ```ini
+   [from-internal]
+   exten => _X.,1,Answer()
+   same => n,Record(/tmp/calls/${UNIQUEID}.wav,0,0)
+   same => n,Set(CALL_ID=${UNIQUEID})
+   same => n,Set(CALLER=${CALLERID(num)})
+   same => n,Set(CALLED=${EXTEN})
+   same => n,AGI(agi://localhost:4573/process_call)
+   same => n,Hangup()
+   ```
+
+2. Configure AGI settings:
+   ```ini
+   [agi]
+   enabled=yes
+   port=4573
+   bindaddr=0.0.0.0
+   ```
+
+3. Test the configuration:
+   ```bash
+   asterisk -rx "dialplan show from-internal"
+   ```
 
-2. **Set Up Database**
-   - Sign up for a free MySQL hosting service:
-     - [PlanetScale](https://planetscale.com/) (Recommended)
-     - [Railway](https://railway.app/)
-     - [Clever Cloud](https://www.clever-cloud.com/)
-   - Create a new MySQL database
-   - Get your database connection URL
+## Customer Integration
+
+### Webhook Setup
+
+1. Download the webhook handler package:
+   ```bash
+   git clone https://huggingface.co/spaces/iajitpanday/vBot/customer_webhook
+   ```
 
-3. **Configure Environment Variables**
+2. Deploy to your web server:
    ```bash
-   # Generate a secure JWT secret
-   python3 -c "import secrets; print(secrets.token_urlsafe(32))"
+   cp -r customer_webhook/* /var/www/html/vbot-webhook/
+   ```
+
+3. Create database:
+   ```sql
+   CREATE DATABASE vbot_calls;
+   USE vbot_calls;
    
-   # Set these environment variables in your Space settings
-   JWT_SECRET=<generated-secret>
-   ADMIN_USERNAME=your-admin-username
-   ADMIN_PASSWORD=your-secure-password
-   DATABASE_URL=mysql+pymysql://username:password@host:port/database
+   CREATE TABLE call_records (
+       id VARCHAR(36) PRIMARY KEY,
+       customer_id INT NOT NULL,
+       caller_number VARCHAR(20) NOT NULL,
+       called_number VARCHAR(20) NOT NULL,
+       transcription TEXT,
+       summary TEXT,
+       sentiment VARCHAR(50),
+       keywords TEXT,
+       created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+       updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
+   );
    ```
 
-4. **Integration with Asterisk**
-   - Get your API key from the admin dashboard
-   - Configure your Asterisk dialplan
-   - Start processing calls
+4. Configure webhook handler:
+   - Copy `config/config.example.php` to `config/config.php`
+   - Update database credentials and API key
 
-## Documentation
+### API Usage
 
-For detailed documentation, please refer to our [User Manual](USER_MANUAL.md).
+1. Process a call:
+   ```bash
+   curl -X POST https://your-domain.com/api/process-call \
+     -H "X-API-Key: your_api_key" \
+     -H "Content-Type: multipart/form-data" \
+     -F "file=@/path/to/call.wav" \
+     -H "caller_number=+1234567890" \
+     -H "called_number=+0987654321"
+   ```
 
-## API Endpoints
+2. Response format:
+   ```json
+   {
+     "success": true,
+     "message": "Call processed successfully",
+     "call_id": "uuid",
+     "transcription": "Call transcript...",
+     "summary": "Call summary...",
+     "sentiment": "positive",
+     "keywords": "keyword1, keyword2"
+   }
+   ```
 
-### 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
+3. Webhook payload:
+   ```json
+   {
+     "call_id": "uuid",
+     "caller_number": "+1234567890",
+     "called_number": "+0987654321",
+     "transcription": "Call transcript...",
+     "summary": "Call summary...",
+     "sentiment": "positive",
+     "keywords": "keyword1, keyword2",
+     "timestamp": "2024-03-14T12:00:00Z",
+     "customer_id": 123
+   }
+   ```
+
+## Security
+
+1. API Authentication:
+   - All API requests require valid API key
+   - API keys are unique per customer
+   - Keys can be regenerated if compromised
+
+2. Webhook Security:
+   - Optional webhook secret for signature validation
+   - HTTPS required for webhook endpoints
+   - Input validation and sanitization
+
+3. Data Protection:
+   - Call recordings are temporary
+   - Analysis results stored securely
+   - Customer data isolation
+
+## Monitoring and Maintenance
+
+1. Logs:
+   - Application logs: `logs/app.log`
+   - Error logs: `logs/error.log`
+   - Access logs: `logs/access.log`
+
+2. Health Checks:
+   - API endpoint: `/health`
+   - Database status
+   - Service status
 
-### Customer Endpoints
-- `POST /api/v1/process-call` - Process call
-- `GET /api/v1/calls/{id}` - List calls
+3. Backup:
+   - Regular database backups
+   - Configuration backups
+   - Log rotation
+
+## Troubleshooting
+
+1. Common Issues:
+   - Database connection errors
+   - API key validation failures
+   - Webhook delivery failures
+
+2. Solutions:
+   - Check database credentials
+   - Verify API key
+   - Test webhook endpoint
+   - Review error logs
 
 ## Support
 
-For support and troubleshooting, please refer to the [Troubleshooting Guide](USER_MANUAL.md#troubleshooting) in our user manual.
+For support:
+- Email: support@vbot.com
+- Documentation: https://vbot.com/docs
+- GitHub Issues: https://github.com/vbot/issues
 
 ## License
 
-MIT License
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Documentation
+
+- [Setup Guide](SETUP_GUIDE.md) - Detailed setup instructions
+- [User Manual](USER_MANUAL.md) - End-user documentation
+- [API Documentation](API_DOCS.md) - API reference and examples
+
+## Architecture
+
+vBot follows a modern API-first architecture:
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference 
+1. **Core Components**:
+   - FastAPI backend
+   - MySQL database
+   - Hugging Face AI models
+   - Asterisk integration
+
+2. **Data Flow**:
+   - Calls are received by Asterisk
+   - Audio is processed by vBot
+   - Results are stored and accessible via API
+   - Customers access data through their API keys
+
+3. **Security**:
+   - JWT-based authentication for admin
+   - API key authentication for customers
+   - Secure data isolation between customers
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch
+3. Commit your changes
+4. Push to the branch
+5. Create a Pull Request
+
+## API Endpoints
+
+### Admin Endpoints
+- `