launchpad-ledger: Update README

This commit is contained in:
willclarktech 2020-09-15 18:54:59 +02:00
parent 0d4baf1fe3
commit 868a792ae5
No known key found for this signature in database
GPG Key ID: 551A86E2E398ADF7

View File

@ -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`. Youll 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