diff --git a/README.md b/README.md index 0c24d80..b1aa41f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ -# wyoming-services +# Wyoming Services -Wyoming protocol wrappers for Chatterbox TTS and faster-whisper STT \ No newline at end of file +Wyoming protocol wrappers for Home Assistant Voice Pipeline integration. + +## Services + +### Wyoming Chatterbox TTS (Port 10201) +Wraps Chatterbox TTS server (10.2.1.104:8004) with Homer Simpson voice. + +### Wyoming faster-whisper STT (Port 10202) +Wraps faster-whisper server (10.2.1.104:8005) with large-v3-turbo model for German. + +## Deployment +Runs on 10.4.1.116 (dockhand VM): +```bash +cd ~/wyoming-chatterbox +docker compose up -d --build +``` + +## HA Integration +Both registered as Wyoming integrations in Home Assistant (10.10.1.20).