Update README.md

- Final update to documentation for 1.3.0.
hopejr · May 7, 2023 · 013efae · 013efae
1 parent 57c849a
commit 013efae
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -43,6 +43,7 @@ Use to retrieve all the devices that are connected.
 Returns:
 - `Object[]` - contains the following information:
   - `id` String - either an MD5 hash of the serial number (if it exists) or the device path, used to distinguish between multiple devices that may be connected at once.
+  - `path` String - the USB device path
   - `name` String - name of the device ('ShuttleXpress', 'ShuttlePro v1', or 'ShuttlePro v2')
   - `hasShuttle` Boolean
   - `hasJog` Boolean
@@ -55,6 +56,7 @@ Returns:
 
 Returns `Object | null`:
   - `id` String - either an MD5 hash of the serial number (if it exists) or the device path, used to distinguish between multiple devices that may be connected at once.
+  - `path` String - the USB device path
   - `name` String - name of the device ('ShuttleXpress', 'ShuttlePro v1', or 'ShuttlePro v2')
   - `hasShuttle` Boolean
   - `hasJog` Boolean