Add some documentation

This commit is contained in:
Yaacov Akiba Slama
2019-08-14 17:47:54 +03:00
committed by GitHub
parent 3eaae4d273
commit 55dc828b62

View File

@@ -1 +1,11 @@
# lspd
# lspd simple server
This sample server works with a lnd node
## Installation
1. git clone https://github.com/breez/lspd (or fork)
1. Modify the code in server.go if you use different values than the default when opening channels
1. Compile lspd using `go build .`
1. Define the environment variables as described in sample.env
1. Run lspd
1. Share with breez the TOKEN and the LISTEN_ADDRESS you defined
## Implement your own server
The grpc methods are described in https://github.com/breez/lspd/blob/master/rpc/lspd.md