Merge pull request #37 from BoltzExchange/rtl-docs

Setup documentation

README.md

@@ -6,7 +6,7 @@ The full documentation can be found [here](https://lnd.docs.boltz.exchange/) or
 
 ## Building
 
-`boltz-lnd` has C dependencies which means a C compiler has to be installed to compile the daemon successfully.
+To build Go version 1.14 or higher is required. `boltz-lnd` also has C dependencies which means a C compiler has to be installed to compile the daemon successfully.
 
 The build process requires patches for dependencies, and some build flags, therefore the `Makefile` in the repository root should be used. 
 

build/version.go

@@ -2,7 +2,7 @@ package build
 
 var Commit string
 
-const version = "1.2.2"
+const version = "1.2.3"
 
 func GetVersion() string {
 	basicVersion := "v" + version

docs/configuration.md

@@ -1,6 +1,6 @@
 # Configuration
 
-`boltz-lnd` can be configured via CLI arguments, and a TOML config file. By default, the config file is called `boltz.toml` and located in the default data directory of `boltz-lnd` (`/home/<user>/.boltz-lnd` on Linux).
+`boltz-lnd` can be configured via CLI arguments, and a TOML config file. By default, the config file is called `boltz.toml` and located in the data directory of `boltz-lnd` (`/home/<user>/.boltz-lnd` by default on Linux).
 
 ## Example
 
@@ -13,7 +13,7 @@ logfile = ""
 logprefix = "[BTC] "
 
 [BOLTZ]
-# By default the daemon automatically connects to the official Boltz instance for the network the LND is on
+# By default the daemon automatically connects to the official Boltz instance for the network LND is on
 # This value is used to override that
 url = "https://testnet.boltz.exchange/api"
 

docs/index.md

@@ -1,20 +1,32 @@
-# boltz-lnd v1.2.2 documentation
+# boltz-lnd v1.2.3 documentation
 
 `boltz-lnd` is a [Boltz](https://boltz.exchange) client for [LND](https://github.com/lightningnetwork/lnd). It supports Normal Submarine Swaps (from onchain to Lightning coins) and Reverse Submarine Swaps (from Lightning to onchain coins).
 
 ## `boltzd`
 
-`boltzd` is a daemon that should run alongside of your LND node. It connects to your LND node, and the Boltz API to create to execute Swaps.
+`boltzd` is a daemon that should run alongside of your LND node. It connects to your LND node, and the Boltz API to create and execute Swaps.
 
-The LND node to which the daemon connects to, has to be version `v0.10.0-beta` or higher. Also, LND needs to be compiled with these build flags (binaries from the official Lightning Labs releases include them):
+## `boltzcli`
+
+`boltzcli` is a CLI tool to interact with the gRPC interface `boltzd` exposes.
+
+## Setup
+
+The LND node to which the daemon connects has to be version `v0.10.0-beta` or higher. Also, LND needs to be compiled with these build flags (official binaries from Lightning Labs releases include them):
 
 - `invoicerpc` (hold invoices)
 - `routerrpc` (multi path payments)
 - `chainrpc` (block listener)
 - `walletrpc` (fee estimations)
 
-Documentation for the configuration of the daemon can be found [here](configuration.md)
+Binaries for the latest release of `boltz-lnd` can be found on the [releases page](https://github.com/BoltzExchange/boltz-lnd/releases). If no binaries are available for your platform, you can build them yourself with the instructions provided in the [README](https://github.com/BoltzExchange/boltz-lnd#building).
 
-## `boltzcli`
+### Configuration
 
-`boltzcli` is a CLI tool to interact with the gRPC interface `boltzd` exposes.
+`boltzd` requires a connection to a LND node. In most cases the CLI flags `--lnd.certificate <path to the tls.cert of LND>` and `--lnd.macaroon <path to the admin.macaroon of LND>` should be enough. To view all CLI flags use `--help`.
+
+`boltzd` can also be configured via a TOML file. The full documentation for the configuration file can be found [here](configuration.md).
+
+### Macaroons
+
+The macaroons for the gRPC server of `boltzd` can be found in the `macaroons` folder inside the data directory of the daemon. By default, that data directory is `~/.boltz-lnd` on Linux.