refactor: move docs to gitbook

README.md

@@ -1,16 +1,17 @@
 # Boltz LND
 
-This repository contains 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 ones (from Lightning to onchain coins).
+This repository contains `boltz-lnd`, a [Boltz](https://boltz.exchange) client for [LND](https://github.com/lightningnetwork/lnd). It supports Normal Submarine Swaps (Bitcoin -> Lightning) and Reverse Submarine Swaps (Lightning -> Bitcoin).
 
-The full documentation can be found [here](https://lnd.docs.boltz.exchange/) or in the `docs` folder
+The full documentation can be found [here](https://docs.boltz.exchange/boltz-lnd) or in the [`docs`](./docs) folder of this repo.
 
 ## Building
 
-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.
+To build `boltz-lnd`, [go](https://github.com/golang/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. 
+The build process requires patches for dependencies, and some build flags, therefore the provided [`Makefile`](Makefile) should be used. 
 
+To start the build process, run:
 ```
 go mod vendor
 make build
-```
+```

docs/SUMMARY.md

@@ -0,0 +1,6 @@
+# Table of contents
+
+* [Configuration](README.md)
+* [gRPC Documentation](grpc.md)
+* [boltz-lnd v1.2.3 documentation](index.md)
+* [< Back to Home](http://localhost:5000/o/SPM8mTvJyc7OIzGL3HD7/s/XUXMXrD8YTzvuqvAeom7/)

docs/configuration.md

@@ -1,25 +1,25 @@
 # 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 data directory of `boltz-lnd` (`/home/<user>/.boltz-lnd` by default on Linux).
+`boltz-lnd` can be configured via a TOML config file or CLI arguments. 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
 
 ```toml
-# Path the the log file
+# Path to the log file
 logfile = ""
 
 # Prefix for all log messages.
-# Useful in cases two boltz-lnd instances (one for BTC and LTC) are running in a single Docker container  
+# Useful in cases where multiple boltz-lnd instances are running in a single Docker container
 logprefix = "[BTC] "
 
 [BOLTZ]
 # 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"
+url = "https://api.boltz.exchange"
 
 [DATABASE]
 # Path to the SQLite database file 
-path = "/home/michael/test.db"
+path = "/home/me/test.db"
 
 [LND]
 # Host of the gRPC interface of LND
@@ -63,6 +63,6 @@ noMacaroons = false
 # Path to the admin macaroon for the gRPC and REST interface
 adminMacaroonPath = ""
 
-# Path to the read only macaroon for the gRPC and REST interface
+# Path to the read-only macaroon for the gRPC and REST interface
 readOnlyMacaroonPath = ""
 ```

docs/index.md

@@ -1,31 +1,31 @@
-# boltz-lnd v1.2.3 documentation
+# Boltz-LND 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).
+`boltz-lnd` is a [Boltz](https://boltz.exchange) client for [LND](https://github.com/lightningnetwork/lnd). It supports Normal Submarine Swaps (Bitcoin -> Lightning) and Reverse Submarine Swaps (Lightning -> Bitcoin).
 
 ## `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 and execute Swaps.
+`boltzd` is the daemon that should run alongside your LND node. It connects to your LND node and hooks it up with [Boltz's API](https://docs.boltz.exchange) to create and execute swaps.
 
 ## `boltzcli`
 
-`boltzcli` is a CLI tool to interact with the gRPC interface `boltzd` exposes.
+`boltzcli` is the CLI tool to interact with the gRPC interface that `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)
+* `invoicerpc` (hold invoices)
+* `routerrpc` (multi path payments)
+* `chainrpc` (block listener)
+* `walletrpc` (fee estimations)
 
-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).
+Binaries of `boltz-lnd` can be found [here](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).
 
 ### Configuration
 
 `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).
+`boltzd` can also be configured via a TOML file. The full documentation for the configuration file can be found [here](./).
 
 ### Macaroons