add readme to vm-cli example

This commit is contained in:
onyx-and-iris 2022-09-17 03:21:04 +01:00
parent 5fb7f5e4db
commit 8a03904ab8

19
examples/vm-cli/README.md Normal file
View File

@ -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
```