From a0268e356559f6010c017dcab476df9f6c20bb58 Mon Sep 17 00:00:00 2001
From: onyx-and-iris <75868496+onyx-and-iris@users.noreply.github.com>
Date: Tue, 11 May 2021 19:17:27 +0100
Subject: [PATCH] update to readme

Added vban section to readme.
---
 CHANGELOG.md |  1 +
 README.md    | 22 ++++++++++++++++++++++
 2 files changed, 23 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index e6ff33c..123d096 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,7 @@ Before any minor/major patch is released all test units will be run to verify th
 ## [Unreleased]
 - [x] Add vban commands
 - [x] Update tests to reflect changes
+- [x] Add vban section to README
 
 ## [1.5] - 2021-05-11
 ### Added
diff --git a/README.md b/README.md
index 496027b..d3ef743 100644
--- a/README.md
+++ b/README.md
@@ -123,6 +123,28 @@ $vmr.button[4].stateonly = $false
 $vmr.button[5].trigger = $true
 ```
 
+### VBAN
+For each vban in/out stream the following parameters are defined:
+- on: boolean
+- name: string
+- ip: string
+- port: int from 1024 - 65535
+- sr: int (11025, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000)
+- channel: int from 1 to 8
+- bit: int 16 or 24
+- quality: int from 0 to 4
+- route: int from 0 to 8
+
+SR, channel and bit are defined as readonly for instreams. Attempting to write
+to those parameters will throw an error. They are read and write for outstreams.
+
+example:
+```powershell
+$vmr.vban_in[0].on = $true
+$vmr.vban_in[2].port = 6990
+$vmr.vban_out[3].bit = 16
+```
+
 ### Run tests
 Run tests using .\runall.ps1 which accepts two parameters:
 - tag Run tests of this type