From ebbc1ddcaeda770885eb72eb6dbe30c652089a4c Mon Sep 17 00:00:00 2001
From: video-prize-ranch <cb.8a3w5@simplelogin.co>
Date: Sat, 30 Apr 2022 14:53:20 -0400
Subject: [PATCH] Add instructions [skip ci]

---
 README.md | 38 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e9832d7..650dba8 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,40 @@
 A streaming proxy for livestreams and videos for [Librarian](https://codeberg.org/librarian/librarian).
 
 ## Usage
-TO-DO
\ No newline at end of file
+stream-proxy should be run seperately on another domain using a reverse proxy such as [Caddy](https://caddyserver.com/).
+
+### Docker (recommended)
+Add the following to your `docker-compose.yml` file. Images for arm64 are currently unavailable, follow the instructions to build from source.
+```
+  stream-proxy:
+    image: registry.gitlab.com/overtime-zone-wildfowl/stream-proxy:latest
+    ports:
+      - 3001:3001
+    restart: unless-stopped
+```
+
+To start, run `sudo docker-compose up -d`. Enable in Librarian by adding the following to your `config.yml` file, then restart Librarian:
+```
+ENABLE_LIVE_STREAM: true
+LIVE_STREAMING_URL: 'https://your.domain.tld/live'
+```
+
+### Build from source
+You will need to install [Rust](https://rustup.rs/). Then run the following commands:
+```sh
+git clone https://codeberg.org/librarian/stream-proxy
+cd stream-proxy
+```
+
+To build:
+```sh
+cargo build --release
+```
+
+The output will be at `target/release/stream-proxy` and can be run with the command `./target/release/stream-proxy`.
+
+Enable in Librarian by adding the following to your `config.yml` file, then restart Librarian:
+```
+ENABLE_LIVE_STREAM: true
+LIVE_STREAMING_URL: 'https://your.domain.tld/live'
+```
\ No newline at end of file