Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Commit

Permalink
Update documentation, make clear Zap Android is for node operators (#346
Browse files Browse the repository at this point in the history
)
  • Loading branch information
michaelWuensch authored Jul 24, 2021
1 parent ad39e30 commit 5279ae5
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

[![Screenshot of Zap Android app](docs/screenshot.png)](https://zaphq.io/)

Native android lightning wallet focused on user experience and ease of use ⚡️
Native android lightning wallet for node operators focused on user experience and ease of use ⚡️

Zap Android works as a remote control for one or more of your LND Nodes. Running LND in neutrino mode directly on the phone might be available later.
Zap Android is not a classical wallet, it is actually a remote control for one or more of your LND Nodes. Zap Android aims to give node operators the opportunity to use their node in everyday situations with a simple and appealing user interface.

The easiest way to get started is using [Umbrel](https://getumbrel.com/) to run LND on a raspberry pi and then connect Zap Android to that node.

Expand All @@ -23,8 +23,10 @@ The easiest way to get started is using [Umbrel](https://getumbrel.com/) to run
- [x] Transaction filter
- [x] Read NFC tags
- [x] [Avatars](https://github.com/michaelWuensch/avathor-rfc#avathor)
- [x] Bitcoin only

**Security**
- [x] Non-custodial
- [x] PIN protected access
- [x] Scrambled PIN by default
- [x] Protection against screen recording
Expand All @@ -37,12 +39,15 @@ The easiest way to get started is using [Umbrel](https://getumbrel.com/) to run
- [x] Connect to remote Lnd node
- [x] Connect to BTCPay Server
- [x] Connect to lndconnect QR code
- [ ] Run lnd on your android phone

## Security

If you discover or learn about a potential error, weakness, or threat that can compromise the security of Zap, we ask you to keep it confidential and [submit your concern directly to the Zap security team](mailto:[email protected]?subject=[GitHub]%20Zap%20Security).

## Non-custodial

Zap Android is fully non-custodial. When using the app there is absolutely no interaction with any Zap team or service. We do not even know you are using our software.

## Get Help

If you are having problems with Zap, please report the issue in [GitHub][issues] or on [slack][slack] with screenshots and/or how to reproduce the bug/error.
Expand Down

0 comments on commit 5279ae5

Please sign in to comment.