From 8a03904ab821daf83d59680fa3e019403c37d0a2 Mon Sep 17 00:00:00 2001
From: onyx-and-iris <75868496+onyx-and-iris@users.noreply.github.com>
Date: Sat, 17 Sep 2022 03:21:04 +0100
Subject: [PATCH] add readme to vm-cli example

---
 examples/vm-cli/README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 examples/vm-cli/README.md

diff --git a/examples/vm-cli/README.md b/examples/vm-cli/README.md
new file mode 100644
index 0000000..0082421
--- /dev/null
+++ b/examples/vm-cli/README.md
@@ -0,0 +1,19 @@
+## About
+
+A simple voicemeeter-cli program. Offers ability to toggle, get and set parameters.
+
+## Use
+
+Toggle with `!` prefix, get by excluding `=` and set by including `=`. Mix and match arguments, for example:
+
+`go run .\main.go strip[0].mute=0 strip[0].mute !strip[0].mute strip[0].mute bus[0].gain=-8.8`
+
+Expected output:
+
+```
+Running command strip[0].mute=0
+Value of strip[0].mute is: 0
+Toggling strip[0].mute
+Value of strip[0].mute is: 1
+Running command bus[0].gain=-8.8
+```