Upload README.md with huggingface_hub

README.md

@@ -1,12 +1,20 @@
----
-title: Huggingface News Podcast
-emoji: 👁
-colorFrom: blue
-colorTo: blue
-sdk: docker
-pinned: false
-license: mit
-short_description: This generates Nigerian-accented speech using YarnGPT
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Nigerian Text-to-Speech API
+
+This is a FastAPI application that provides Nigerian accented text-to-speech capabilities using YarnGPT.
+
+## Features
+
+- Convert text to speech with Nigerian accent
+- Easy-to-use API endpoints
+- 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
+
+## Deployment
+
+The application is deployed on Hugging Face Spaces using Docker.