launchpad-ledger: Update README for transport restructure

This commit is contained in:
willclarktech 2020-10-06 12:33:53 +02:00
parent 46d84455ec
commit 00e3701234
No known key found for this signature in database
GPG Key ID: 551A86E2E398ADF7

View File

@ -4,25 +4,16 @@
## Supported platforms
This library works with Node.js as well as certain browsers. We use the
This library must be provided with a Ledger transport, and has been tested with
appropriate transports for Node.js as well as certain browsers. In our demo code
we use
[@ledgerhq/hw-transport-node-hid](https://github.com/LedgerHQ/ledgerjs/tree/master/packages/hw-transport-node-hid)
to connect to Ledger devices from Node.js. 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