From b8bcea59fc92c9b6816ce2018e39ebf62d3fc1e1 Mon Sep 17 00:00:00 2001
From: onyx-and-iris <code@onyxandiris.online>
Date: Wed, 25 Jun 2025 15:17:45 +0100
Subject: [PATCH] add link to OBS

add note about env vars
---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index 4dc1738..1618452 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,7 @@ Run it as a CLI or a GUI.
 ## Requirements
 
 -   Python 3.11 or greater
+-   [OBS Studio 28+][obs-studio]
 
 ## Installation
 
@@ -27,6 +28,22 @@ uv tool install simple-recorder
 pipx install simple-recorder
 ```
 
+## Configuration
+
+Pass --host, --port and --password as flags on the root command:
+
+```console
+simple-recorder --host=localhost --port=4455 --password=<websocket password> --help
+```
+
+Or load them from your environment:
+
+```env
+OBS_HOST=localhost
+OBS_PORT=4455
+OBS_PASSWORD=<websocket password>
+```
+
 ## Use
 
 Without passing a subcommand (start/stop) a GUI will be launched, otherwise a CLI will be launched.
@@ -62,3 +79,5 @@ simple-recorder stop
 ```
 
 If no filename is passed to start then you will be prompted for one. A default_name will be used if none is supplied to the prompt.
+
+[obs-studio]: https://obsproject.com/
\ No newline at end of file