Upload README.md with huggingface_hub

README.md

@@ -1,20 +1,44 @@
+---
+title: Nigerian Text-to-Speech API
+emoji: 🎙️
+colorFrom: green
+colorTo: blue
+sdk: docker
+app_port: 7860
+pinned: false
+---
+
 # Nigerian Text-to-Speech API
 
-This is a FastAPI application that provides Nigerian accented text-to-speech capabilities using YarnGPT.
+A FastAPI-based Text-to-Speech API that generates Nigerian-accented speech from text input.
 
 ## Features
-
-- Convert text to speech with Nigerian accent
-- Easy-to-use API endpoints
+- Convert text to speech with Nigerian accents
+- RESTful API endpoints
+- Docker containerized deployment
 - Built with FastAPI and YarnGPT
 
 ## API Endpoints
 
-- GET `/`: Health check
-- POST `/tts`: Convert text to speech
-- GET `/list_files`: List available audio files
-- GET `/audio/{file_id}`: Download specific audio file
+### Health Check
+- `GET /` - Check API status
+
+### Text to Speech
+- `POST /tts` - Convert text to speech
+  - Request body: `{"text": "Your text here", "accent": "nigerian"}`
+  - Returns: Audio file (WAV format)
+
+### Audio Management
+- `GET /list_files` - List available audio files
+- `GET /audio/{file_id}` - Get specific audio file
+
+## Environment
+- Python 3.9
+- FastAPI
+- YarnGPT for TTS generation
+- Docker containerized
 
-## Deployment
+Last updated: 2025-04-22 05:09:31 UTC
+Created by: Abdulhameed556
 
-The application is deployed on Hugging Face Spaces using Docker.
+For more information about this project, visit [Hugging Face Spaces](https://huggingface.co/spaces/Hameed13/Huggingface_News_Podcast)