Skip to content

Commit 4b931dc

Browse files
committed
feat: add initial changelog and update README for version 3.0.0 release
1 parent abf4665 commit 4b931dc

2 files changed

Lines changed: 14 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
3+
## [3.0.0] - 2026-06-06
4+
5+
### Changed
6+
- Initial release of the rust-based node-usb library
7+
- Now uses the rust `nusb` library instead of `libusb`
8+
- Dropped support for the `Legacy API` and exclusively uses the `WebUSB` API

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Node.JS library for communicating with USB devices.
88

99
This is a complete rewrite in rust using [@kevinmehall](https://github.com/kevinmehall)'s excellent [nusb library](https://docs.rs/nusb/latest/nusb) and [napi-rs](https://napi.rs/).
1010

11+
For the previous v2.x.x version of node-usb, please see https://github.com/node-usb/node-usb.
12+
1113
# License
1214
[MIT](LICENSE.md)
1315

@@ -151,11 +153,13 @@ If using a packaging system for electron, ensure the `node-usb` library does not
151153
- npmRebuild: false
152154

153155
# APIs
154-
Since `v3.0.0`, the `node-usb` API follows the WebUSB specification which can be found here:
156+
Since `v3.0.0`, the API exclusively follows the WebUSB specification which can be found here:
155157

156158
https://wicg.github.io/webusb/
157159

158-
Two versions of the WebUSB API exist by default:
160+
If you want to use the older `Legacy API`, please install [v2.x.x of node-usb](https://github.com/node-usb/node-usb).
161+
162+
Two versions of the API exist by default:
159163

160164
- `usb` - which exposes all functionality in an unrestricted manner (e.g. without needing to `requestDevice()` first)
161165
- `webusb` - which follows the WebUSB specification exactly and requires the user to authorise devices via `requestDevice()` first.

0 commit comments

Comments
 (0)