G2/cross-usb
1
0
Fork 0
mirror of https://github.com/G2-Games/cross-usb.git synced 2025-04-19 05:12:53 -05:00
Code Issues Projects Releases Packages Wiki Activity

Improved readme

Browse source
This commit is contained in:
G2-Games 2024-08-14 18:55:03 -05:00
parent a04497594e
commit 1c193fb97c
1 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -21,9 +21,13 @@ A USB library which works seamlessly across most native and WASM targets.
## Dependencies ## Dependencies
For native USB, the crate utilizies [nusb](https://github.com/kevinmehall/nusb), a pure rust library similar to the very popular libusb. For native USB, the crate utilizies [nusb](https://github.com/kevinmehall/nusb),
a pure rust library similar to the very popular libusb. **If you don't need WASM
support, just using `nusb` is the way to go!**
For WASM, this crate utilizes [web-sys](https://crates.io/crates/web-sys) which gives access to browser API calls, and in this case is used to interact with [WebUSB](https://developer.mozilla.org/en-US/docs/Web/API/WebUSB_API) For WASM, this crate utilizes [web-sys](https://crates.io/crates/web-sys) which
gives access to browser API calls, and in this case is used to interact with
[WebUSB](https://developer.mozilla.org/en-US/docs/Web/API/WebUSB_API).
## Example ## Example
To learn about how USB communciations work, check out [USB in a NutShell](https://www.beyondlogic.org/usbnutshell/usb1.shtml). To learn about how USB communciations work, check out [USB in a NutShell](https://www.beyondlogic.org/usbnutshell/usb1.shtml).
@ -63,6 +67,8 @@ Check out the [documentation](https://docs.rs/cross_usb/latest/) as well!
## TODO ## TODO
- [ ] Add choice for native backend between `libusb` wrapper and pure rust `nusb` - [ ] Add choice for native backend between `libusb` wrapper and pure rust
`nusb`
- [ ] Allow platform-specific operations if the user requires them - [ ] Allow platform-specific operations if the user requires them
- [ ] Hot plug support... requires either using `libusb` as an optional backend or for [`nusb` to implement it](https://github.com/kevinmehall/nusb/issues/5) - [ ] Hot plug support... requires either using `libusb` as an optional backend
or for [`nusb` to implement it](https://github.com/kevinmehall/nusb/issues/5)