aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPinapelz <yukais@pinapelz.com>2026-04-18 17:40:25 -0700
committerGitHub <noreply@github.com>2026-04-18 17:40:25 -0700
commit8d75470ecdb4cb70a6c114adee7e931a5ea8eae5 (patch)
treebb4b2f16ca32540f9371a90fa24a253e21fae219 /README.md
parent85a1c3df4b0f04f94c2d0179c21eeda36f9a9e3c (diff)
Enhance README with transcription details and client example
Added details about transcription inaccuracies and example client.
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 81e729f..996bba1 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,10 @@
# auto-live-tl
A basic LOCAL translation backend that listens to an audio sink via PCM and runs translation via faster-whisper
-Translations a
+Translations and trascriptions are transformers based, inaccuracies and hallucinations will occur.
`server.py` serves a backend for translating incoming audio data. It expects some other client to hit the `/events` endpoint to fetch the translated data.
+
+`youtube-subtitle.user.js` is one such example client that can fetch data from this endpoint and render it beneath a YouTube video. You can install it as a userscript.
+
+<img width="1210" height="109" alt="image" src="https://github.com/user-attachments/assets/2bffde45-bc61-4d63-b779-b7a8cd183bc0" />
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage