Improve repo docs

README.md

@@ -72,13 +72,10 @@ Usage of bin/invoicer:
 * Or (if you use ex. neutrino) disable bitcoind dependency by adding: `off-chain-only=true` to config,
 * Make sure the certificate provided via `tls = ` in `[lnd]` section has your domain/IP added,
 * To have `GET /history` endpoint available, make sure to add `user = "password"` pairs to `[users]` section,
-* By default all API paths start with `localhost:8080/api/`,
-* By default all other paths serve content from path passed as `static-dir = `, 
-* To keep binary running use `screen`, `tmux`, `Docker` or service manager of your choice.
-
-**NOTE_2:** Invoicer `v0.4` has changed default config location from `~/.invoicer/` to `~/.lncm/`, please move your `invoicer.conf` config accordingly.
-**NOTE_3:** Invoicer's logs are, by default stored in `~/.lncm/invoicer.log`, and are rotated every time log file reaches 100MB.
-
+* By default, all API paths start with `localhost:8080/api/`,
+* By default, all other paths serve content from path passed as `static-dir = `,
+* To keep binary running use `screen`, `tmux`, `Docker` or service manager of your choice,
+* Logging to file can be disabled by putting `log-file=none` to `invoicer.conf`.
 
 Docker
 ---
@@ -89,11 +86,11 @@ Run:
 
 ```bash
 docker run -it --rm \
-    -v $(pwd)/:/root/.lncm/ \
+    -v $(pwd)/:/data/ \
     -p 8080:8080 \
     --name invoicer \
     --detach \
-    lncm/invoicer:latest
+    lncm/invoicer:v0.7.0
 ```
 
 
@@ -352,20 +349,6 @@ On error, returns:
 > **NOTE:** most recent invoice is on the bottom  
 
 
-Deployment
----
-
-To deploy the binary to your Raspberry Pi, run (replacing all values with ones specific to your setup):
-
-```bash
-$ make deploy REMOTE_USER=root REMOTE_HOST=pi-hdd REMOTE_DIR=/home/ln/bin/ 
-``` 
-
-If you want to expose donations page [see here], and make sure to expose port `:8080` on your firewall.  The page will be located at path root.
-
-[see here]: https://github.com/lncm/donations/releases
-
-
 Development
 ---
 

invoicer.example.conf

@@ -1,18 +1,27 @@
 # Note: all values used in this file are defaults that are used if nothing is provided
 
 port = 8080
+
+# directory hosting `index.html` be served at `/`
 static-dir = "static/"
+
+# Location of the log file.  Set this to `none` to disable logging to file
 log-file = "~/.lncm/invoicer.log"
+
+# Currently, that's the only valid option
 ln-client = "lnd"
 
+# Disable accepting off-chain payments by setting this to `true`
 off-chain-only = false
 
+# Specify how invoicer should communicate with your full node.
 [bitcoind]
 host = "localhost"
 port = 8332
 user = "invoicer"
 pass = ""
 
+# Specify how invoicer should communicate with your lnd node
 [lnd]
 host = "localhost"
 port = 10009
@@ -23,6 +32,8 @@ kill-count = 4
 invoice = "./invoice.macaroon"
 readonly = "./readonly.macaroon"
 
+
+# Add `username = "password"` pairs to enable `/api/history` endpoint
 [users]
 # username = "password"