Update README.md

README.md

@@ -2,14 +2,18 @@
 
 A packaged TouchDesigner component that connects to an [OBS](https://obsproject.com) WebSocket server and receives all available events.
 
-## Usage
+## Basic Usage
 
 1. Download the .tox file from the `/dist` folder and place it in a location convenient for your project.
 2. Drag and drop it into your project.
 3. Set the Address and Port of the server in the Connection parameters tab. Set the Password if there is one.
 4. If Auto-Reconnect is enabled: the component will connect to the server automatically.  
    If Auto-Reconnect is disabled: enable the Active switch to connect to the server.
 
+## Features
+
+### High-Volume Events
+
 Several events are considered "high-volume" and must be individually opted into to receive them. You can do this in the Connection parameters tab. These events are:
 
 - Input Volume Meters
@@ -21,6 +25,40 @@ Once connected, any event data received will be set in the corresponding paramet
 
 It's possible to enable or disable high-volume events while connected to the server. This will force a reconnect, however.
 
+### Sending Requests
+
+Two methods on the OBSWebSocket component can be used to send requests to OBS.
+
+- `SendRequest(type, data)` - Sends a single request.
+
+  - `type` - A `RequestType` enum value.
+  - `data` - A dict containing any input the request requires.
+
+- `SendRequestBatch(data, executionType, haltOnFailure)` - Sends one or more requests together.
+
+  - `data` - An array of dicts with the form:
+
+    ```python
+    {
+        "requestType": RequestType or str
+        # Optional. A custom string used to track the request.
+        "requestId": str
+        # Optional. A dict containing any input the request requires.
+    	"requestData": object
+    }
+    ```
+
+  - `executionType` - A `RequestBatchExecutionType` enum value. Defaults to `SERIAL_REALTIME` for one-by-one execution.
+  - `haltOnFailure` - Stops the batch if one request fails. Defaults to `False`.
+
+The `RequestType` and `RequestBatchExecutionType` enums are promoted by the extension and can be easily accessed on the OBSWebSocket component with `OBSWebSocket.RequestType` and `OBSWebSocket.RequestBatchExecutionType` respectively.
+
+Each request type's inputs for the `data` parameter or `requestData` field can be found in the [obs-websocket documentation][1].
+
+For batch requests, it is recommended to provide a custom `requestId` with each request. This will help you identify responses in the results table where each one is logged until the next request is sent.
+
 ## Contributing
 
-A custom Release component can be found in the project that automates the packaging, so simply make changes, increase the Version parameter (following [semver](https://semver.org)), and click the Release button.
+A custom Release component can be found in the project that automates the packaging, so simply make changes, increase the Version parameter (following [semver](https://semver.org)), and click the Package button.
+
+[1]: https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#general-requests