Skip to content

Commit

Permalink
Merge remote-tracking branch 'nomic-io/readme-tweaks' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
keppel committed Oct 18, 2023
2 parents 10db4f4 + 5f79b7e commit ac3a451
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ npm install nomic-bitcoin
import { generateDepositAddress } from 'nomic-bitcoin'

let depositInfo = await generateDepositAddress({
relayers: ['https://testnet-relayer.nomic.io:8443'],
relayers: ['https://relayer.nomic-testnet.mappum.io:8443'],
channel: 'channel-0', // IBC channel ID on Nomic
network: 'testnet',
receiver: 'cosmos1...', // bech32 address of the depositing user
Expand All @@ -46,10 +46,15 @@ Bitcoin sent to `bitcoinAddress` before the expiration date will be automaticall

### QR code

A QR code similar to the below will be returned in base64 and should be shown on users on desktop devices for ease of use with mobile wallets.
A QR code similar to the below will be returned as a base64 data URL string and should be shown to users on desktop devices for ease of use with mobile wallets.

![QR code example](https://raw.githubusercontent.com/nomic-io/nomic-bitcoin-js/main/qr-code-styling.png)

The returned data URL can be used as the `src` attribute on `img` elements:
```jsx
<img src={qrCodeData} />
```


### Capacity limit

Expand Down

0 comments on commit ac3a451

Please sign in to comment.