From 918776dc1b9b720d7604bc24d9cb449275dfe1c5 Mon Sep 17 00:00:00 2001
From: Erick Hitter <git-contrib@ethitter.com>
Date: Fri, 29 Dec 2017 21:21:11 -0800
Subject: [PATCH] Readme updates
---
README.md | 10 +++++++++-
dyndnsd-client.go | 2 +-
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 6c717db..2d8cce7 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,12 @@
dyndnsd-client
==============
-Client for the [`dyndnsd`](https://github.com/cmur2/dyndnsd) daemon.
+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 no arguments, as `config.json` handles everything.
diff --git a/dyndnsd-client.go b/dyndnsd-client.go
index 6dfc0b1..def1809 100644
--- a/dyndnsd-client.go
+++ b/dyndnsd-client.go
@@ -18,7 +18,7 @@ var (
logger *log.Logger
)
-// Parse config
+// Preparations
func init() {
// Logging
logOpts := log.Ldate | log.Ltime | log.LUTC | log.Lshortfile
--
GitLab