Skip to content

Commit

Permalink
mention the three implementations.
Browse files Browse the repository at this point in the history
  • Loading branch information
fiatjaf committed May 2, 2019
1 parent a696bfe commit 667294b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<img src="https://i.imgur.com/Opk21LD.png" alt="kWh" style="max-width:100%;" width="400">
</p>

<p align="center">The companion browser extension for c-lightning nodes.</p>
<p align="center">The companion browser extension for c-lightning, Eclair and Ptarmigan nodes.</p>

<p align="center">
<a href="https://addons.mozilla.org/firefox/addon/kwh/"><img src="https://i.imgur.com/aNCB2LG.png" alt="Install for Firefox" width="215" style="max-width:100%;"></a>
Expand All @@ -15,21 +15,25 @@
- [`webln`](https://webln.dev/#/) support;
- Pay highlighted invoice with a context menu click;
- Handle `lightning:` links;
- [Generate invoice here](https://youtu.be/wzkxxz5FsJo) context menu;
- ["Generate invoice here"](https://youtu.be/wzkxxz5FsJo) context menu;
- Manual payments and invoice creation;
- No popups, all interactions happen in the browserAction.
- No window popups, all interactions happen in the `browserAction` popup.

<p align="center">
<img src="screenshots/withdraw-checkmark-tippin.gif" width="400" />
</p>

### Requirements

A [lightningd](https://github.com/ElementsProject/lightning/) with a [Spark](https://github.com/shesek/spark-wallet) [RPC server](https://github.com/fiatjaf/sparko) in front of it.
Either

* a [lightningd](https://github.com/ElementsProject/lightning/) node with a [Spark](https://github.com/shesek/spark-wallet) [RPC server](https://github.com/fiatjaf/sparko) in front of it;
* an [Eclair](https://github.com/ACINQ/eclair) node with the [API](https://github.com/ACINQ/eclair#configuring-eclair) enabled and accessible;
* a [Ptarmigan](https://github.com/nayutaco/ptarmigan) node with the [REST API Node.js app](https://github.com/nayutaco/ptarmigan/blob/master/docs/howtouse_rest_api.md) running.

### Build instructions

You'll need: Node.js>=10, npm>=6, GNU Make>=4
You'll need: Node.js>=10, npm, Make

```
npm install
Expand Down
2 changes: 1 addition & 1 deletion static/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
},
"manifest_version": 2,
"name": "kWh",
"description": "Make lightning payments in the browser with c-lightning",
"description": "Send and receive Lightning payments in the browser with c-lightning, Eclair or Ptarmigan.",
"version": "0.5.0",
"author": "fiatjaf",
"icons": {
Expand Down

0 comments on commit 667294b

Please sign in to comment.