Update README.md

inadyn/README.md

@@ -26,33 +26,88 @@ comparison to installing any other Hass.io add-on.
 To configure with addon options, no webUI.
 For configuration, see https://github.com/troglobit/inadyn
 
+### Configuration
+
+The available configuration options are as follows (this is filled in with some example data):
+
 ```
-"verify_address": "bool?",
+{
-"fake_address": "bool?",
+  "verify_address": false,
-"allow_ipv6": "bool?",
+  "fake_address": false,
-"iface": "str?",
+  "allow_ipv6": true,
-"iterations": "int?",
+  "iface": "eth0",
-"period": "int?",
+  "iterations": 0,
-"forced_update": "bool?",
+  "period": 300,
-"secure_ssl": "bool?",
+  "forced_update": false,
-"providers":
+  "secure_ssl": true,
-      - "provider": "str",
+  "providers": [
-        "custom_provider": "bool?",
+    {
-        "username": "str",
+      "provider": "providerslug",
-        "password": "str?",
+      "custom_provider": false,
-        "ssl": "bool?",
+      "username": "yourusername",
-        "hostname": "str",
+      "password": "yourpassword_or_token",
-        "checkip_ssl": "bool?",
+      "ssl": true,
-        "checkip_server": "str?",
+      "hostname": "dynamic-subdomain.example.com",
-        "checkip_command": "str?",
+      "checkip_ssl": false,
-        "checkip_path": "str?",
+      "checkip_server": "api.example.com",
-        "user_agent": "str?",
+      "checkip_command": "/sbin/ifconfig eth0 | grep 'inet6 addr'",
-        "wildcard": "bool?",
+      "checkip_path": "/",
-        "ddns_server": "str?",
+      "user_agent": "Mozilla/5.0",
-        "ddns_path": "str?",
+      "ddns_server": "ddns.example.com",
-        "append_myip": "bool?"
+      "ddns_path": "",
+      "append_myip": false
+    }
+  ]
+}
 ```
 
+You should not fill in all of these, only use what is necessary. A typical example would look like:
+
+```
+{
+    {
+      "provider": "duckdns",
+      "username": "your-token",
+      "hostname": "sub.duckdns.org"
+    }
+  ]
+}
+```
+
+or:
+
+```
+{
+  "providers": [
+    {
+      "provider": "someprovider",
+      "username": "username",
+      "password": "password",
+      "hostname": "your.domain.com"
+    }
+  ]
+}
+```
+
+for a custom provider that is not supported by inadyn you can do:
+```
+{
+  "providers": [
+    {
+      "provider": "arbitraryname",
+      "username": "username",
+      "password": "password",
+      "hostname": "your.domain.com",
+      "ddns_server": "api.cp.easydns.com",
+      "ddns_path": "/somescript.php?hostname=%h&myip=%i",
+      "custom_provider": true
+    }
+  ]
+}
+```
+
+the tokens in ddns_path are outlined in the `inadyn.conf(5)` man page.
+
 [smb-shield]: https://img.shields.io/badge/SMB--green?style=plastic.svg
 [repository]: https://github.com/alexbelgium/hassio-addons
 [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg