From 43367525c517d3f55277fd5d400dbca0bea84bcc Mon Sep 17 00:00:00 2001
From: onyx-and-iris <code@onyxandiris.online>
Date: Thu, 17 Aug 2023 02:56:38 +0100
Subject: [PATCH] Errors section added to README

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index 09b2f83..3535f53 100644
--- a/README.md
+++ b/README.md
@@ -542,6 +542,15 @@ 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.
 
+### Errors
+
+- `VMRemoteError`: Base custom error class.
+- `LoginError`: Raised when a login error occurs.
+- `CAPIError`: Raised when a C-API function returns an error code.
+  - The following class properties are available:
+    - `function`: The name of the C-API function that returned the error code.
+    - `code`: The error code.
+
 ### Run tests
 
 Run tests using .\tests\pre-commit.ps1 which accepts the following parameters: