diff --git a/packages/launchpad-ledger/README.md b/packages/launchpad-ledger/README.md index 4cd9ca24..0d2f1b40 100644 --- a/packages/launchpad-ledger/README.md +++ b/packages/launchpad-ledger/README.md @@ -4,14 +4,38 @@ ## Supported platforms -We use the +This library works with Node.js as well as certain browsers. We use the [@ledgerhq/hw-transport-webusb](https://github.com/LedgerHQ/ledgerjs/tree/master/packages/hw-transport-webusb) library to connect to Ledger devices from the browser via USB. You can check the support status of this library [here](https://github.com/LedgerHQ/ledgerjs/tree/master/packages/hw-transport-webusb#support-status). +Note the optional dependencies: + +```json +"optionalDependencies": { + "@ledgerhq/hw-transport-node-hid": "^5.23.2", + "@ledgerhq/hw-transport-webusb": "^5.23.0" +} +``` + +If you are using this library with Node.js you must install +`@ledgerhq/hw-transport-node-hid`. You’ll need `@ledgerhq/hw-transport-webusb` +for the browser. + ## Running the demo +### Node.js + +Connect the Ledger device via USB, open the Cosmos app, then run the demo (this +will also build the package): + +```sh +yarn demo-node +``` + +### Browser + Build the package for web: ```sh