add entry/exit functions to readme.

rethrow LoginError exceptions, let the consumer handle it.

CHANGELOG.md

@@ -30,6 +30,7 @@ v3 introduces some breaking changes. They are as follows:
 
 -   meta functions refactored, they now use identifier() functions.
 -   OBS example reworked, now using obs-powershell module.
+-   Rethrow LoginError for unknown kind exceptions, let the consumer handle it from there.
 
 ### Added
 
@@ -46,7 +47,7 @@ v3 introduces some breaking changes. They are as follows:
 
 ### Removed
 
--   Bus[i].mode\_{param} parameters removed. Replaced with Bus[i].mode.
+-   Bus[i].mode\_{param} members removed. Replaced with Bus[i].mode.{param}
 
 ## [2.5.0] - 2022-10-27
 

README.md

@@ -79,6 +79,19 @@ Voicemeeter factory function can be:
 -   Get-RemoteBanana
 -   Get-RemotePotato
 
+Added in v3 you may also use the following entry/exit points:
+
+-   Connect-Voicemeeter
+-   Disconnect-Voicemeeter
+
+`Connect-Voicemeeter` takes a single parameter `Kind`.
+
+for example:
+
+```powershell
+$vmr = Connect-Voicemeeter -Kind "potato"
+```
+
 #### `Through the Shell`
 
 One liners should be run through a subshell, you may pipe the Remote object to a script block, for example:
@@ -173,7 +186,7 @@ The following strip.gate commands are available:
 for example:
 
 ```powershell
-$vmr.strip[3].gate.knob = 3.3
+$vmr.strip[3].gate.threshold = -40.5
 ```
 
 #### denoiser

lib/Voicemeeter.psm1

@@ -105,7 +105,7 @@ Function Connect-Voicemeeter {
     }
     catch [LoginError] {
         Write-Warning $_.Exception.ErrorMessage()
-        Exit
+        throw
     }
 }
 

lib/base.ps1

@@ -45,7 +45,7 @@ function Login {
     }
     catch [LoginError], [CAPIError] {
         Write-Warning $_.Exception.ErrorMessage()
-        exit
+        throw
     }
 
     while (P_Dirty -or M_Dirty) { Start-Sleep -m 1 }