Update to Godot 4.1

.github/workflows/deploy.yml

@@ -99,7 +99,7 @@ jobs:
           cat>$bin_dir/../$bin_name.gdextension<<EOF
           [configuration]
           entry_symbol = "hid_lib_init"
-          compatibility_minimum = 4.0
+          compatibility_minimum = 4.1
           [libraries]
           ${{ matrix.build }}.x86_64 = "bin/$bin_file"
           EOF

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "hid"
-version = "0.0.1"
+version = "0.0.2"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

README.md

@@ -1,5 +1,28 @@
 ## A hidapi extension for godot
 
-> WIP
-
 * Written by rust with gdext
+
+> How to use it: Download the release archive and decompress it to your godot project root directory.
+
+
+Example:
+```
+func _ready():
+    # List all connected HID devices.
+    var devices = Hid.list_devices()
+    print(devices)
+
+    var hid = Hid.new()
+    # Open by vender id and product id
+    hid.open(vid, pid)
+    # Or open by device path
+    #hid.open_path(path)
+    # Or open by serial number
+    #hid.open_serial(vid, pid, serial_number)
+
+    # Then you can read HID report data from device.
+    var report_recv = hid.read(64)
+    #var report_recv = hid.read_timeout(64, 10)
+    # And write report data to HID
+    hid.write(report_send)
+```