From ace19b98f7e3250d4520a4b893d4aeabe58118c7 Mon Sep 17 00:00:00 2001
From: pommicket <pommicket@gmail.com>
Date: Tue, 30 Sep 2025 21:29:17 -0400
Subject: Prepare for release

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dd41b02
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# simpleddns
+
+Very simple DDNS client with support for
+
+- Linode, DigitalOcean, and AWS Route 53 providers.
+- Allows obtaining IP address via any shell command.
+- Customize TTL, API call interval & timeout.
+- Multiple domains.
+
+Run `install.sh` to install.
+Then run `simpleddns --setup` to create a configuration interactively.
+Lastly run `simpleddns` to start the DDNS client.
+Currently only Unixy platforms are supported (i.e. not Windows, but maybe WSL or MinGW or something).
+
+
+## Alternatives
+
+This particular set of features is somewhat unique.
+But there are other DDNS clients out there:
+
+- [godns](https://github.com/TimothyYe/godns)
+- [ddclient](https://github.com/ddclient/ddclient)
+
+
+## Example systemd service
+
+(This assumes a user `simpleddns` has installed the program.)
+
+```
+[Unit]
+Description=Simple DDNS client
+After=network.target
+ 
+[Service]
+Restart=always
+RestartSec=20
+User=simpleddns
+WorkingDirectory=~
+ExecStart=/bin/sh -c .local/bin/simpleddns
+ 
+[Install]
+WantedBy=multi-user.target
+```
-- 
cgit v1.2.3