Skip to content

Commit

Permalink
Merge pull request #128 from getAlby/rolznz-patch-1
Browse files Browse the repository at this point in the history
doc: update NWC docs to mention additional supported webln methods
  • Loading branch information
rolznz authored Nov 11, 2023
2 parents 2991b04 + d3959a1 commit f14482a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Nostr Wallet Connect is an open protocol enabling applications to interact with

The Alby JS SDK allows you to easily integrate Nostr Wallet Connect into any JavaScript based application.

The `NostrWebLNProvider` exposes the [WebLN](webln.guide/) sendPayment interface to execute lightning payments through Nostr Wallet Connect.
The `NostrWebLNProvider` exposes the [WebLN](webln.guide/) interface to execute lightning wallet functionality through Nostr Wallet Connect, such as sending payments, making invoices and getting the node balance.

(Note: in the future more WebLN functions will be added to Nostr Wallet Connect)

Expand Down Expand Up @@ -69,7 +69,7 @@ if (!window.webln) {

### NostrWebLNProvider Functions

The goal of the Nostr Wallet Connect provider is to be API compatible with [webln](https://www.webln.guide/). Currently not all methods are supported and only `sendPayment` is specified.
The goal of the Nostr Wallet Connect provider is to be API compatible with [webln](https://www.webln.guide/). Currently not all methods are supported - see the examples/nwc directory for a list of supported methods.

#### `static withNewSecret()`

Expand Down

0 comments on commit f14482a

Please sign in to comment.