From fdf9163d7d9d87e6f2530176687a625203085d4f Mon Sep 17 00:00:00 2001
From: Zoe Roux <zoe.roux@zoriya.dev>
Date: Thu, 8 Aug 2024 16:40:09 +0200
Subject: [PATCH] Add a readme for gocoder

---
 transcoder/README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 transcoder/README.md

diff --git a/transcoder/README.md b/transcoder/README.md
new file mode 100644
index 00000000..36d5e0d5
--- /dev/null
+++ b/transcoder/README.md
@@ -0,0 +1,33 @@
+# Gocoder
+
+## Features
+
+- Lazily transcode via **HLS**
+  - Support automatic quality switches
+  - Support transmuxing as a quality
+  - Allows multiples clients to share the same transcode stream
+- Hardware acceleration support (vaapi, qsv, cuda)
+- Extract **media info** from files (bitrate, chapters...) and stores it in database
+- Extract and serves **subtitles** or attachments (like fonts)
+- Create **thumbnails sprites** (& vtt metadata) for scrubbing (mouse hover on seek bar)
+
+## Usage
+
+Gocoder is shipped as a docker image configurable via env variables (see `.env.example`). Using it outside Kyoo is supported.
+There is no swagger as of now, you can look at `main.go` for the list of routes.
+
+Projects using gocoder:
+- Kyoo (obviously)
+- [Meelo](https://github.com/Arthi-chaud/Meelo)
+- [Blee](https://github.com/Arthi-chaud/Blee)
+- Add your own?
+
+## TODO:
+- Add a swagger
+- Add configurable JWT authorization (v5 of kyoo)
+- Add credits/recaps/intro/preview detection
+- Add multiples qualities for audio streams
+- Improve multi-video support
+- Add optional redis synchronization for replication (`RunLock` was made with this in mind)
+- fmp4 support
+- transcode downloads