docs: enhance documentation clarity by correcting button field, link paths, and minor wording.

Author: JakubAndrysek

CONTRIBUTING.md

@@ -6,7 +6,7 @@
 3. Create a pull request to `master` and assign a reviewer.
 4. The reviewer will review your code and merge it into `master`.
 
-## Adding new device
+## Adding a new device
 
 This section describes how to add support for a new SpaceMouse or similar 6-DOF device.
 

README.md

@@ -86,7 +86,7 @@ with pyspacemouse.open() as device:
 with pyspacemouse.open(device="SpaceNavigator") as device:
     state = device.read()
 
-# Open second device (when multiple same devices)
+# Open second device when multiple identical devices are connected
 with pyspacemouse.open(device_index=1) as device:
     state = device.read()
 
@@ -164,7 +164,7 @@ with pyspacemouse.open(device_spec=custom) as device:
     state = device.read()
 ```
 
-See [Custom Device Configuration](./mouseApi/index.md#custom-device-configuration) for full API.
+See [Custom Device Configuration](./docs/mouseApi/index.md#custom-device-configuration) for full API.
 
 ## CLI
 

docs/CONTRIBUTING.md

@@ -6,7 +6,7 @@
 3. Create a pull request to `master` and assign a reviewer.
 4. The reviewer will review your code and merge it into `master`.
 
-## Adding new device
+## Adding a new device
 
 This section describes how to add support for a new SpaceMouse or similar 6-DOF device.
 

docs/README.md

@@ -54,6 +54,9 @@ with pyspacemouse.open() as device:
 
 ## API Reference
 
+From version 2.0.0 the API has been modularized and changed.
+Please look at the [API Reference](./mouseApi/index.md) and [Examples](https://github.com/JakubAndrysek/PySpaceMouse/tree/master/examples) for more information.
+
 ### Device Discovery
 
 ```python
@@ -83,7 +86,7 @@ with pyspacemouse.open() as device:
 with pyspacemouse.open(device="SpaceNavigator") as device:
     state = device.read()
 
-# Open second device (when multiple same devices)
+# Open second device when multiple identical devices are connected
 with pyspacemouse.open(device_index=1) as device:
     state = device.read()
 

docs/mouseApi/index.md

@@ -49,7 +49,7 @@ State objects returned from `read()` have 7 attributes: [t,x,y,z,roll,pitch,yaw,
 * t: timestamp in seconds since the script started.
 * x,y,z: translations in the range [-1.0, 1.0]
 * roll, pitch, yaw: rotations in the range [-1.0, 1.0].
-* button: list of button states (0 or 1), in order specified in the device specifier
+* buttons: list of button states (0 or 1), in order specified in the device specifier
 
 ## Custom Device Configuration