From e092ed3c4e6361a1439b2c9db0838b0b5c5d5ac0 Mon Sep 17 00:00:00 2001
From: onyx-and-iris <code@onyxandiris.online>
Date: Thu, 5 Feb 2026 15:42:39 +0000
Subject: [PATCH] add Configuration section to README

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index 7adc574..4ba5b1e 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,30 @@
 go install github.com/onyx-and-iris/xair-cli@latest
 ```
 
+### Configuration
+
+#### Flags
+
+Although there exist flags/environment variables for `--host`, `--port` and `--kind` you should only need `--host` for xair mixers and `--host`, `--kind` for the x32.
+
+- --host/-H: You mixers IP
+- --kind/-k: The kind of mixer, use this to connect to an x32. It does two things:
+  - Adjusts the port to 10023
+  - Updates some of the OSC addresses.
+
+#### Environment Variables
+
+Example .envrc:
+
+```bash
+#!/usr/bin/env bash
+
+XAIR_CLI_HOST=mixer.local
+XAIR_CLI_PORT=10024
+XAIR_CLI_KIND=xr18
+XAIR_CLI_RAW_TIMEOUT=50ms
+```
+
 ### Use
 
 ```console