diff --git a/README.md b/README.md index 193f930..aeeaeb6 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ # lspd simple server -This sample server works with a lnd node +This is a simple example of an lspd server that works with an [lnd](https://github.com/lightningnetwork/lnd) node. +This server exposes LSP services to the [Breez client](https://github.com/breez/breezmobile). + ## 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 +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