From 85a47098e10dcf233dc382cbba678d415c0a215a Mon Sep 17 00:00:00 2001
From: onyx-and-iris <code@onyxandiris.online>
Date: Wed, 26 Jun 2024 17:13:04 +0100
Subject: [PATCH] add `API Commands` section to README

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

diff --git a/README.md b/README.md
index 9490b13..75c9f4b 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,22 @@ Where:
 - `k`: The kind of Voicemeeter (basic, banana or potato). Use this to launch the GUI.
 - `D`: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL
 
+## `API Commands`
+
+- Commands starting with `!` will be toggled, use it with boolean parameters.
+- Commands containing `=` will set a value.
+- All other commands with get a value.
+
+Examples:
+
+Launch basic GUI, set debug level to INFO, Toggle Strip 0 Mute, then print its new value
+
+`./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute`
+
+Launch banana GUI, set debug level to DEBUG, set Strip 0 label to podmic then print Strip 2 label
+
+`vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label`
+
 ## `Script files`
 
 Scripts can be loaded from text files, for example: