From cf3b62bfdabe6ad1d96ffe1ef7b1143c53658d84 Mon Sep 17 00:00:00 2001
From: Erick Hitter <git-contrib@ethitter.com>
Date: Sat, 30 Dec 2017 15:49:15 -0800
Subject: [PATCH] README updates

---
 README.md          | 27 +++++++++++++++++++++------
 config-sample.json |  2 +-
 2 files changed, 22 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index a9f5631..9d07300 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,27 @@
-dyndnsd-client
-==============
+`dyndnsd-client`
+================
 
 Client for the [`dyndnsd`](https://github.com/cmur2/dyndnsd) daemon. Set up `dyndnsd` first, otherwise this is useless.
 
-## Configuration
-
-Copy `config-sample.json` to `config.json` and update the values.
-
 ## Use
 
 Set up a cron entry to run the program periodically, or manually call it when your IP address changes. The program accepts a single argument, `-config`, pointing to a `config.json` file that handles everything. A sample `config.json` is provided in the form of `config-sample.json`.
+
+## Configuration Options
+
+* `username`: daemon username
+* `password`: daemon password
+* `protocol`: `http` or `https`, preferably the latter
+* `host`: IP or hostname of `dnydnsd` instance
+* `port`: port `dyndnsd` is listening on
+* `path`: path to `dnydnsd` daemon, typically `nic/update`
+* `dns_hostname`: the `nsd` zone to update
+* `ipv4_endpoint`: GET-accessible endpoint that returns an IPv4 IP address as a string; when in doubt, use `http://whatismyip.akamai.com/`
+* `ipv6_endpoint`: GET-accessible endpoint that returns an IPv6 IP address as a string; when in doubt, use `http://ipv6.whatismyip.akamai.com/`
+* `ipv6_use_prefix`: if running multiple instances on the same network, use only the IPv6 prefix, omitting the instance portion of the address; this greatly reduces unnecessary `nsd` updates
+
+## Proxying via `nginx`
+
+`dnydnsd` doesn't support HTTPS, so using `nginx` as an HTTPS proxy is recommended. Sending a username and password over an unsecured connection should be avoided if possible.
+
+More coming soon...
diff --git a/config-sample.json b/config-sample.json
index 193e51d..070ffed 100644
--- a/config-sample.json
+++ b/config-sample.json
@@ -8,5 +8,5 @@
   "dns_hostname": "",
   "ipv4_endpoint": "http://whatismyip.akamai.com/",
   "ipv6_endpoint": "http://ipv6.whatismyip.akamai.com/",
-  "ipv6_use_prefix": true
+  "ipv6_use_prefix": false
 }
\ No newline at end of file
-- 
GitLab