From 9c26df784d6bf9b2759475bcd761616a27f0fe08 Mon Sep 17 00:00:00 2001
From: Mid <>
Date: Mon, 20 Jan 2025 10:13:48 +0200
Subject: [PATCH] README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..73a736f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# Matroska over WebSocket Streaming
+
+This repository actually holds three programs, so be careful to not lost in the saurce.
+
+* After `make` completes, `wsrA` is the relay program, which can be run as so: `./wsrA port=12345 key=MyFancyStreamingKeyIsOVERHERE`.
+* Using the above example, one should stream to the HTTP path `/push/MyFancyStreamingKeyIsOVERHERE`. All other paths are expected to be used by WebSocket clients.
+* If using a reverse proxy (highly recommended), make sure to disable request buffering and the maximum request size. For nginx, you want `proxy_request_buffering off; client_max_body_size 0;`.
+* `index.html`, `blarf.js`, `blarfwork.js`, `support.js` and `support.wasm` are the frontend, which must be accessible to the browser.
+* You may insert a file named `intermission.jpg` that is shown when the stream is offline.
+* Of course you'll have to change the feed and chat endpoints in the `index.html`, if you don't want my stream.
+* You may also disable chat by setting `ENABLE_CHAT` to `false`.