Skip to content

Commit

Permalink
feat/LIVE-3858 Update README.md files to use new logo and links
Browse files Browse the repository at this point in the history
  • Loading branch information
juan-cortes committed Sep 22, 2022
1 parent 2f473b2 commit ecac411
Show file tree
Hide file tree
Showing 33 changed files with 154 additions and 96 deletions.
36 changes: 36 additions & 0 deletions .changeset/stupid-shirts-smoke.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
"@ledgerhq/cryptoassets": patch
"@ledgerhq/devices": patch
"@ledgerhq/errors": patch
"@ledgerhq/hw-app-algorand": patch
"@ledgerhq/hw-app-btc": patch
"@ledgerhq/hw-app-cosmos": patch
"@ledgerhq/hw-app-eth": patch
"@ledgerhq/hw-app-helium": patch
"@ledgerhq/hw-app-polkadot": patch
"@ledgerhq/hw-app-solana": patch
"@ledgerhq/hw-app-str": patch
"@ledgerhq/hw-app-tezos": patch
"@ledgerhq/hw-app-trx": patch
"@ledgerhq/hw-app-xrp": patch
"@ledgerhq/hw-transport-http": patch
"@ledgerhq/hw-transport-mocker": patch
"@ledgerhq/hw-transport-node-ble": patch
"@ledgerhq/hw-transport-node-hid-noevents": patch
"@ledgerhq/hw-transport-node-hid-singleton": patch
"@ledgerhq/hw-transport-node-hid": patch
"@ledgerhq/hw-transport-node-speculos-http": patch
"@ledgerhq/hw-transport-node-speculos": patch
"@ledgerhq/hw-transport-web-ble": patch
"@ledgerhq/hw-transport-webhid": patch
"@ledgerhq/hw-transport-webusb": patch
"@ledgerhq/hw-transport": patch
"@ledgerhq/logs": patch
"@ledgerhq/react-native-hid": patch
"@ledgerhq/react-native-hw-transport-ble": patch
"@ledgerhq/types-cryptoassets": patch
"@ledgerhq/types-devices": patch
"@ledgerhq/types-live": patch
---

Updated readme.md of packages
2 changes: 1 addition & 1 deletion libs/ledgerjs/packages/cryptoassets/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

## @ledgerhq/cryptoassets

Expand Down
2 changes: 1 addition & 1 deletion libs/ledgerjs/packages/devices/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

## @ledgerhq/devices

Expand Down
2 changes: 1 addition & 1 deletion libs/ledgerjs/packages/errors/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

## @ledgerhq/errors

Expand Down
7 changes: 4 additions & 3 deletions libs/ledgerjs/packages/hw-app-algorand/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-app-algorand

Expand Down
7 changes: 4 additions & 3 deletions libs/ledgerjs/packages/hw-app-btc/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-app-btc

Expand Down
7 changes: 4 additions & 3 deletions libs/ledgerjs/packages/hw-app-cosmos/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-app-cosmos

Expand Down
7 changes: 4 additions & 3 deletions libs/ledgerjs/packages/hw-app-eth/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-app-eth

Expand Down
7 changes: 4 additions & 3 deletions libs/ledgerjs/packages/hw-app-helium/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-app-helium

Expand Down
7 changes: 4 additions & 3 deletions libs/ledgerjs/packages/hw-app-polkadot/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-app-polkadot

Expand Down
7 changes: 4 additions & 3 deletions libs/ledgerjs/packages/hw-app-solana/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-app-solana

Expand Down
2 changes: 1 addition & 1 deletion libs/ledgerjs/packages/hw-app-str/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

## Ledger Stellar app API

Expand Down
7 changes: 4 additions & 3 deletions libs/ledgerjs/packages/hw-app-tezos/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-app-tezos

Expand Down
7 changes: 4 additions & 3 deletions libs/ledgerjs/packages/hw-app-trx/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-app-trx

Expand Down
7 changes: 4 additions & 3 deletions libs/ledgerjs/packages/hw-app-xrp/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-app-xrp

Expand Down
7 changes: 4 additions & 3 deletions libs/ledgerjs/packages/hw-transport-http/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

## @ledgerhq/hw-transport-http

Library for Ledger Hardware Wallets.

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## API

Expand Down
7 changes: 4 additions & 3 deletions libs/ledgerjs/packages/hw-transport-mocker/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

## @ledgerhq/hw-transport-mocker

Library for Ledger Hardware Wallets.

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## API

Expand Down
9 changes: 4 additions & 5 deletions libs/ledgerjs/packages/hw-transport-node-ble/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-transport-node-ble

**Ledger Hardware Wallet Bluetooth BLE transport for Node.js (noble)**

> yarn add @ledgerhq/hw-transport-node-ble
## API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-transport-node-hid-noevents

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-transport-node-hid-singleton

Expand All @@ -13,7 +14,7 @@ Allows to communicate with Ledger Hardware Wallets.

## Are you adding Ledger support to your software wallet?

You may be using this package to open a USB connexion between your desktop application and the device.
You may be using this package to open a USB connection between your desktop application and the device.

For a smooth and quick integration:

Expand Down
7 changes: 4 additions & 3 deletions libs/ledgerjs/packages/hw-transport-node-hid/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-transport-node-hid

Expand Down
11 changes: 6 additions & 5 deletions libs/ledgerjs/packages/hw-transport-node-speculos-http/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

## @ledgerhq/hw-transport-node-speculos-http

A transport for <https://github.com/LedgerHQ/speculos> Nano simulator using it's http api.
A transport for <https://github.com/LedgerHQ/speculos> Nano simulator using its HTTP API.

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

### Getting started

* Install <https://github.com/LedgerHQ/speculos>
* Make sure to have a speculos running with an api port (default port is 5000).
* Make sure to have a speculos running with an API port (default port is 5000).

```js
import SpeculosTransport from "@ledgerhq/hw-transport-node-speculos-http";
Expand Down
9 changes: 5 additions & 4 deletions libs/ledgerjs/packages/hw-transport-node-speculos/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

## @ledgerhq/hw-transport-node-speculos

A transport for <https://github.com/LedgerHQ/speculos> Nano simulator.

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

### Getting started

* Install <https://github.com/LedgerHQ/speculos>
* Make sure to have a speculos running with a APDU port and (optionally) a buttons port available.
* Make sure to have a speculos running with an APDU port and (optionally) a buttons port available.

```js
import SpeculosTransport from "@ledgerhq/hw-transport-node-speculos";
Expand Down
9 changes: 5 additions & 4 deletions libs/ledgerjs/packages/hw-transport-web-ble/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-transport-web-ble

Expand All @@ -13,7 +14,7 @@ Allows to communicate with Ledger Hardware Wallets.

## Are you adding Ledger support to your software wallet?

You may be using this package to open a Bluetooth connexion between your web application and the device.
You may be using this package to open a Bluetooth connection between your web application and the device.

For a smooth and quick integration:

Expand Down
11 changes: 6 additions & 5 deletions libs/ledgerjs/packages/hw-transport-webhid/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />
<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)
[GitHub](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-transport-webhid

Expand All @@ -13,7 +14,7 @@ Allows to communicate with Ledger Hardware Wallets.

## Are you adding Ledger support to your software wallet?

You may be using this package to open a USB connexion between your web application and the device.
You may be using this package to open a USB connection between your web application and the device.

For a smooth and quick integration:

Expand All @@ -24,7 +25,7 @@ For a smooth and quick integration:

### FAQ: "DOM Exception" is triggered when creating the transport

The transport functions `create()` and `listen()` must be called in the context of an user interaction (like a **"click"** event), otherwise it fails with DOM Exception. This is by WebUSB design. You also must run on HTTPS.
The transport functions `create()` and `listen()` must be called in the context of a user interaction (like a **"click"** event), otherwise it fails with DOM Exception. This is by WebUSB design. You also must run on HTTPS.

### How to use this transport?

Expand Down
Loading

0 comments on commit ecac411

Please sign in to comment.