rewording in readme

README.md

@@ -1,23 +1,26 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/voicemeeter-api-powershell/blob/dev/LICENSE)
+
 # Powershell Wrapper for Voicemeeter API
-A simple wrapper in Powershell to the Voicemeeter API.
+
+This module offers a Powershell interface for the Voicemeeter Remote C API.
 
 For past/future changes to this project refer to: [CHANGELOG](CHANGELOG.md)
 
 ## Tested against
-- Basic 1.0.8.1
-- Banana 2.0.6.1
-- Potato 3.0.2.1
 
-You may have success with many commands in earlier versions but some commands
+-   Basic 1.0.8.1
-(example Macrobuttons) were only added to the API in later releases.
+-   Banana 2.0.6.1
+-   Potato 3.0.2.1
 
 ## Requirements
-- Voicemeeter: https://voicemeeter.com/
+
-- Powershell 5.1
+-   [Voicemeeter](https://voicemeeter.com/)
+-   Powershell 5.1
 
 ## Installation
+
 #### PowerShellGet:
+
 In Powershell as admin:
 
 `Install-Module Voicemeeter`
@@ -31,19 +34,23 @@ You may be asked to install NuGet provider required by PowerShellGet if you don'
 When prompted you will need to accept PSGallery as a trusted repository.
 
 More Info:
-- [PowerShellGet](https://docs.microsoft.com/en-us/powershell/scripting/gallery/installing-psget?view=powershell-7.1)
+
-- [NuGet](https://www.powershellgallery.com/packages/NuGet/1.3.3)
+-   [PowerShellGet](https://docs.microsoft.com/en-us/powershell/scripting/gallery/installing-psget?view=powershell-7.1)
-- [PSGallery](https://docs.microsoft.com/en-gb/powershell/scripting/gallery/overview?view=powershell-7.1)
+-   [NuGet](https://www.powershellgallery.com/packages/NuGet/1.3.3)
+-   [PSGallery](https://docs.microsoft.com/en-gb/powershell/scripting/gallery/overview?view=powershell-7.1)
 
 #### Direct download:
+
 `git clone https://github.com/onyx-and-iris/voicemeeter-api-powershell.git`
 
 All examples in this readme assume you've installed as a module.
 If you decide to direct download see [alternative instructions](FROM_SOURCE.md).
 
 ## Use
+
 When you instantiate Remote class you will automatically be logged in. Use a
 try finally block to ensure you logout at the end of your code.
+
 ```powershell
 Import-Module Voicemeeter
 
@@ -65,24 +72,27 @@ finally { $vmr.Logout() }
 ```
 
 Voicemeeter factory function can be:
-- Get-RemoteBasic
+
-- Get-RemoteBanana
+-   Get-RemoteBasic
-- Get-RemotePotato
+-   Get-RemoteBanana
+-   Get-RemotePotato
 
 ### Strip
+
 The following strip commands are available:
-- mute: bool
+
-- mono: bool
+-   mute: bool
-- mc: bool
+-   mono: bool
-- k: int, from 0 to 4
+-   mc: bool
-- solo: bool
+-   k: int, from 0 to 4
-- A1-A5: bool
+-   solo: bool
-- B1-B3: bool
+-   A1-A5: bool
-- limit: int, from -40 to 12
+-   B1-B3: bool
-- gain: float, from -60 to 12
+-   limit: int, from -40 to 12
-- comp: float, from 0 to 10
+-   gain: float, from -60 to 12
-- gate: float, from 0 to 10
+-   comp: float, from 0 to 10
-- gainlayer0-gainlayer7: float
+-   gate: float, from 0 to 10
+-   gainlayer0-gainlayer7: float
 
 for example:
 
@@ -97,15 +107,17 @@ gainlayers defined for Potato version only.
 mc, k for virtual strips only.
 
 ### Bus
+
 The following bus commands are available:
-- mute: bool
+
-- mono: bool
+-   mute: bool
-- eq: bool
+-   mono: bool
-- limit: int, from -40 to 12
+-   eq: bool
-- gain: float, from -60 to 12
+-   limit: int, from -40 to 12
-- mode_: bool, any of the following:
+-   gain: float, from -60 to 12
-@('normal', 'amix', 'bmix', 'repeat', 'composite', 'tvmix', 'upmix21',
+-   mode\_: bool, any of the following:
-        'upmix41', 'upmix61', 'centeronly', 'lfeonly', 'rearonly')
+    @('normal', 'amix', 'bmix', 'repeat', 'composite', 'tvmix', 'upmix21',
+    'upmix41', 'upmix61', 'centeronly', 'lfeonly', 'rearonly')
 
 for example:
 
@@ -114,10 +126,12 @@ $vmr.bus[3].mode_repeat = $true
 ```
 
 ### Macrobuttons
+
 Three modes defined: state, stateonly and trigger.
-- State runs associated scripts
+
-- Stateonly does not run associated scripts
+-   State runs associated scripts
-- Index range (0, 69)
+-   Stateonly does not run associated scripts
+-   Index range (0, 69)
 
 ```
 $vmr.button[3].state = $true
@@ -128,23 +142,26 @@ $vmr.button[5].trigger = $true
 ```
 
 ### VBAN
-- vmr.vban.enable: Toggle VBAN on or off. Accepts a boolean value.
+
+-   vmr.vban.enable: Toggle VBAN on or off. Accepts a boolean value.
 
 For each vban in/out stream the following parameters are defined:
-- on: boolean
+
-- name: string
+-   on: boolean
-- ip: string
+-   name: string
-- port: int from 1024 - 65535
+-   ip: string
-- sr: int (11025, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000)
+-   port: int from 1024 - 65535
-- channel: int from 1 to 8
+-   sr: int (11025, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000)
-- bit: int 16 or 24
+-   channel: int from 1 to 8
-- quality: int from 0 to 4
+-   bit: int 16 or 24
-- route: int from 0 to 8
+-   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.enable = $true
 
@@ -154,19 +171,23 @@ $vmr.vban.outstream[3].bit = 16
 ```
 
 ### Command
+
 Certain 'special' commands are defined by the API as performing actions rather than setting values.
 
 The following methods are available:
-- show
+
-- hide
+-   show
-- restart
+-   hide
-- shutdown
+-   restart
+-   shutdown
 
 The following properties are write only and accept boolean values:
-- showvbanchat
+
-- lock
+-   showvbanchat
+-   lock
 
 example:
+
 ```powershell
 $vmr.command.show
 
@@ -174,20 +195,24 @@ $vmr.command.lock = $true
 ```
 
 ### Recorder
+
 The following methods are available:
-- play
+
-- stop
+-   play
-- pause
+-   stop
-- record
+-   pause
-- ff
+-   record
-- rw
+-   ff
+-   rw
 
 The following properties accept boolean values.
-- loop
+
-- A1 - A5
+-   loop
-- B1 - B3
+-   A1 - A5
+-   B1 - B3
 
 example:
+
 ```powershell
 $vmr.recorder.play
 
@@ -195,7 +220,9 @@ $vmr.recorder.loop = $true
 ```
 
 ### Multiple parameters
+
 Set many strip/bus/macrobutton/vban parameters at once, for Example
+
 ```powershell
 Import-Module Voicemeeter
 
@@ -220,16 +247,20 @@ finally { $vmr.Logout() }
 ```
 
 ### Remote class
+
 Access to lower level Getters and Setters are provided with these functions:
-- `$vmr.Getter(param)`: For getting the value of a parameter expected to return a value other than string.
+
-- `$vmr.Getter_String(param)`: For getting the value of any parameter expected to return a string.
+-   `$vmr.Getter(param)`: For getting the value of a parameter expected to return a value other than string.
-- `$vmr.Setter(param, value)`: For setting the value of any parameter.
+-   `$vmr.Getter_String(param)`: For getting the value of any parameter expected to return a string.
+-   `$vmr.Setter(param, value)`: For setting the value of any parameter.
 
 Access to lower level polling functions are provided with these functions:
-- `$vmr.PDirty`: Returns true if a parameter has been updated.
+
-- `$vmr.MDirty`: Returns true if a macrobutton has been updated.
+-   `$vmr.PDirty`: Returns true if a parameter has been updated.
+-   `$vmr.MDirty`: Returns true if a macrobutton has been updated.
 
 example:
+
 ```powershell
 $vmr.Getter('Strip[2].Mute')
 $vmr.Getter_String('Bus[1].Label')
@@ -238,9 +269,11 @@ $vmr.Setter('Strip[0].Gain', -3.6)
 ```
 
 ### Config Files
+
 `$vmr.Set_Profile('config')`
 
-You may load config files in psd1 format. An example profile has been included with the package. Remember to save current settings before loading a profile. To test simply rename _profiles directory to profiles. It will be loaded into memory but not set. To set one you may do:
+You may load config files in psd1 format. An example profile has been included with the package. Remember to save current settings before loading a profile. To test simply rename \_profiles directory to profiles. It will be loaded into memory but not set. To set one you may do:
+
 ```powershell
 Import-Module Voicemeeter
 try {
@@ -249,12 +282,15 @@ try {
 }
 finally { $vmr.Logout() }
 ```
+
 will load a config file at profiles/banana/config.psd1 for Voicemeeter Banana.
 
 ### Run tests
+
 Run tests using .\runall.ps1 which accepts two parameters:
-- tag Run tests of this type
+
-- num Run this number of tests
+-   tag Run tests of this type
+-   num Run this number of tests
 
 Current test types are 'higher' and 'lower'
 
@@ -264,4 +300,5 @@ Example:
 Results will be logged and summary file written.
 
 ### Official Documentation
-- [Voicemeeter Remote C API](https://forum.vb-audio.com/viewtopic.php?f=8&t=346)
+
+-   [Voicemeeter Remote C API](https://forum.vb-audio.com/viewtopic.php?f=8&t=346)