From 4e7cca817db059c308103fe0e0b03c3241816d8d Mon Sep 17 00:00:00 2001
From: Jacek Kowalski <Jacek@jacekk.info>
Date: Thu, 01 Aug 2024 19:16:03 +0000
Subject: [PATCH] Add README

---
 README.md |   33 +++++++++++++++++++++++++++++++++
 1 files changed, 33 insertions(+), 0 deletions(-)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b9b774
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Text-to-speech API based on Facebook's MMS
+
+Simple Python-based container with everything that is needed
+to have a self-hosted web-based text-to-speech API.
+
+## Using the container
+
+Just run:
+
+```
+docker run -d -p 8000:8000 ghcr.io/jacekkow/docker-text-to-speech-api-mms:master
+```
+
+and then visit http://localhost:8000/docs
+
+There is a simple `/sythesize` endpoint that expects a JSON and returns a wave file:
+
+```
+curl -o result.wav -X 'POST' \
+  'http://localhost:8000/synthesize' \
+  -H 'Content-Type: application/json' \
+  -d '{"language": "en", "text": "Sample text."}'
+```
+
+## Adding languages
+
+Currently only English and Polish models are included in the image.
+
+To add additional languages you can simply add extra entries
+in `src/config.py` file and rebuild the container.
+
+Supported language model codes can be found on Hugging Face:
+https://huggingface.co/models?sort=downloads&search=facebook%2Fmms-tts-

--
Gitblit v1.9.1