From e9c9947d98e8e935cfc779c983701505fffb5df2 Mon Sep 17 00:00:00 2001 From: Benjamin Kyd Date: Fri, 2 Nov 2018 11:48:23 +0000 Subject: [PATCH] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 1e72295..1dd2992 100644 --- a/README.md +++ b/README.md @@ -1 +1,9 @@ # DuckDNS-Updater + +A simple node script to update a duckdns dynamicdns domain and relavent dns record with your current ip. Best suited for use cases where a dynamic ip needs to act static for a web server, or other applications. + +## Installation instructions + +`npm i` in the directory in a terminal to initalize the project, upon first running with node it will exit it's self having generated a config - fill out this config and then run it again, it will do the rest for you. run with CLI args `-v` or `--verbose` to log server responses and other information. + +Keep the delay interval to `120000`ms for best results.