Update README.md

This commit is contained in:
CapDog 2021-03-26 15:55:43 -04:00 committed by GitHub
parent 47db5a1041
commit bd036fbf24

View file

@ -7,9 +7,13 @@
<p></p> <p></p>
This is an alpha release of the Shockwallet backend service.<br> This is an alpha release of the Shockwallet backend service, providing a wrapper for [LND](https://github.com/shocknet/lnd/releases) and a daemon for a decentralized social graph over [GUN](https://gun.eco/).<br>
For easy setup on your Laptop/Desktop, [a wizard is available here.](https://github.com/shocknet/wizard) Run this service on your Lightning node and connect with a mobile device or desktop browser.
### Easy Installation
For easy setup on your Laptop/Desktop, [a node wizard is available here.](https://github.com/shocknet/wizard)
### Manual Installation ### Manual Installation
@ -25,7 +29,9 @@ For easy setup on your Laptop/Desktop, [a wizard is available here.](https://git
(Neutrino example requires builds with experimental flags, our binaries include them.) (Neutrino example requires builds with experimental flags, our binaries include them.)
```./lnd --bitcoin.active --bitcoin.mainnet --bitcoin.node=neutrino --neutrino.connect=neutrino.shock.network --routing.assumechanvalid --accept-keysend --allow-circular-route --feeurl=https://nodes.lightning.computer/fees/v1/btc-fee-estimates.json``` ```
./lnd --bitcoin.active --bitcoin.mainnet --bitcoin.node=neutrino --neutrino.connect=neutrino.shock.network --routing.assumechanvalid --accept-keysend --allow-circular-route --feeurl=https://nodes.lightning.computer/fees/v1/btc-fee-estimates.json
```
2) Download and Install API 2) Download and Install API
@ -39,6 +45,9 @@ yarn install
3) Run with `yarn start` 3) Run with `yarn start`
4) Connect with Shockwallet *(Provide your nodes IP manually or scan QR from ShockWizard)* 4) Connect with Shockwallet *(Provide your nodes IP manually or scan QR from ShockWizard)*
*Optionally, add the `--tunnel` flag to create an ssh connection through a tunnel.rip webserver for zero-configuration networking. All communication between the api and wallet is end-to-end encrypted and your privacy is protected.*
### Docker for Raspberry Pi ### Docker for Raspberry Pi
* [Instructions](https://gist.github.com/boufni95/3f4e1f19cf9525c3b7741b7a29f122bc) * [Instructions](https://gist.github.com/boufni95/3f4e1f19cf9525c3b7741b7a29f122bc)