update readme

README.md

@@ -1,18 +1,20 @@
 Namesilo DDNS without Dependences
 ===================
 
-`namesilo_ddns_wodep` is a shell script for Namesilo DDNS based on Bash builtin commands.
+`namesilo_ddns_wodep` is a command line tool written in pure Shell for Namesilo DDNS.
 
-It is designed for light-weight Linux distributions to dispense with 3rd-party dependences or libraries.
+It is designed mainly to reduce dependences and system load as much as possible.
 
-### Version 2 Upgrade (2020.11)
+Therefore, light-weight Linux distributions are especially appropriate to use it, like Raspberry, Openwrt, Merlin, DSM, QTS...
+
+# Version 2 Upgrade (2020.11)
 
 * Rewrite based on Bash builtin commands, and remove all other dependences except for `wget` or `curl`.
-* No API request needed for normal running by using cache, and possible for IP-checking with high frequency.
+* No API request needed for normal running by using cache in log, and possible for IP-checking with high frequency.
 * Create running log with automatic compression and length control.
 * Enable command-line support.
 
-### Feathers
+# Feathers
 
 * [x] Multi-Domains Support
 * [x] IPv4 & IPv6 Support
@@ -21,20 +23,20 @@ It is designed for light-weight Linux distributions to dispense with 3rd-party d
 * [x] Logging with length control
 * [x] Minimal API requests
 
-### Requirements
+# Requirements
 
 * Necessary: `wget` or `curl`
 * Optional:  `date`, `sleep`
 
-### Tested System
+# Tested System
 
 * `DSM 6.2.3`
 * `Ubuntu 20.04.1 LTS (WSL2)`
-* `EdgeOS (Debian 9)`
+* `EdgeRouter X v2.0.8-hotfix.1 (EdgeOS based on Debian 9)`
 
-### Usage
+# Usage
 
-```
+```bash
 Usage: namesilo_ddns.sh <command> ... [parameters ...]
 Commands:
   --help                   Show this help message
@@ -63,3 +65,91 @@ Tips:
 ```
 
 You can also edit the configs and settings in the head of script.
+
+# Applications
+
+## Regular Running for common Linux
+
+  1. SSH to your device , and place `namesilo_ddns.sh` into somewhere, like `/opt/ddns/`.
+
+  2. Make sure your permissions of destination and script:
+```bash
+chmod u+w /opt/ddns
+chmod u+x /opt/ddns/namesilo_ddns.sh
+```
+
+  3. Edit crontab config:
+```bash
+crontab -e
+```
+  
+  4. Insert and save this line (updating the two hosts every 5 minutes):
+```bash
+*/5 * * * *  /opt/ddns/namesilo_ddns.sh -k c40031261ee449037a4b44b1 -h subdomain1.yourdomain1.tld -h subdomain2.yourdomain2.tld
+```
+
+
+## Regular Running for Synology DSM
+
+  1. Place `namesilo_ddns.sh` into somewhere in your NAS, e.g. `/homes/<yourname>/ddns/`.
+
+  2. Start `Control Panel`, click `Advanced Mode`, open `Task Scheduler`.
+
+  3. Access `Create` --> `Scheduled Task` --> `User-defined script`.
+
+  4. Toggle to `Schedule` tab, set running every 5 minutes daily.
+
+  5. Toggle to `Task Settings` tab, in `Run command` input edited command below, e.g.
+```bash
+/var/services/homes/<yourname>/ddns/namesilo_ddns.sh -k c40031261ee449037a4b44b1 -h subdomain1.yourdomain1.tld -h subdomain2.yourdomain2.tld
+```
+
+  6. If you check out `Send run details by email` and `... only when ... terminates abnormally`, you will receive mail when occur error.
+
+    
+## Use in Asuswrt-Merlin
+
+### Why use this solution? If you want to
+
+  * DDNS multiple hosts
+
+  * DDNS IPv6 hosts
+
+  * reduce API requests greatly
+
+  * check updating log
+
+### Setup
+
+  1. Edit the API key and hosts in this script, and save as `ddns-start`.
+```bash
+#! /bin/bash
+
+./namesilo_ddns.sh -k c40031261ee449037a4b44b1 \
+      -h subdomain1.yourdomain1.tld \
+      -h subdomain2.yourdomain2.tld \
+      --ipv4 "$1"
+      --ipv6 auto
+
+if [ $? -eq 0 ]; then
+  /sbin/ddns_custom_updated 1
+else
+  /sbin/ddns_custom_updated 0
+fi
+```
+
+  2. SSH to  your router and place `ddns-start` and `namesilo_ddns.sh` under `/jffs/scripts/`.
+
+  3. Make sure your permissions of destination and script:
+```bash
+chmod u+w /jffs/scripts
+chmod u+x /jffs/scripts/namesilo_ddns.sh
+chmod u+x /jffs/scripts/ddns-start
+```
+
+  4. Log into the router web UI:
+      - Go to `Advanced Settings` > `WAN` > `DDNS`
+      - Set `Server` to `Custom`
+      - Click the `Apply` button
+
+- [Reference](https://github.com/alphabt/asuswrt-merlin-ddns-namesilo)