From d84d30b75207b1cd1a0160220550f42ba26f8892 Mon Sep 17 00:00:00 2001
From: onyx-and-iris <code@onyxandiris.online>
Date: Mon, 19 Jun 2023 17:46:43 +0100
Subject: [PATCH] update readme Errors section

---
 .gitignore | 5 ++++-
 README.md  | 4 +++-
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/.gitignore b/.gitignore
index f07d212..6918ff5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -47,4 +47,7 @@ venv.bak/
 
 # Test/config
 quick.py
-config.toml
\ No newline at end of file
+config.toml
+obsws.log
+
+.vscode/
\ No newline at end of file
diff --git a/README.md b/README.md
index 46b8849..4ae670b 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,7 @@ By default the clients connect with parameters:
 -   `host`: "localhost"
 -   `port`: 4455
 -   `password`: ""
+-   `timeout`: None
 
 You may override these parameters by storing them in a toml config file or passing them as keyword arguments.
 
@@ -41,7 +42,6 @@ A valid `config.toml` might look like this:
 host = "localhost"
 port = 4455
 password = "mystrongpass"
-timeout = 3
 ```
 
 It should be placed in your user home directory.
@@ -132,6 +132,8 @@ If a request fails an `OBSSDKError` will be raised with a status code.
 
 For a full list of status codes refer to [Codes](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus)
 
+If a timeout occurs during sending/receiving a request or receiving an event an `OBSSDKTimeoutError` will be raised.
+
 ### Logging
 
 If you want to see the raw messages simply set log level to DEBUG