commit a1f59b739a88f257b54029200838d4b7ca8b45af
Author: Piotr Icikowski <piotrekicikowski@gmail.com>
Date:   Fri Nov 17 07:17:56 2023 +0100

    chore(repo): add README

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a99a1d5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# DirectAdmin DNS records syncer
+
+This tool synchronizes DNS records between DDNS and DirectAdmin.
+
+I'm unable to find decent solution for sending updates from my Archer C6, so I came up with a tool that is intended to query TP-Link DDNS service (`ns1.tplinkdns.com`) for my router's external IP and to update DNS record for `int` subdomain in DirectAdmin panel.
+
+When life gives you lemons then spin up the hamster ¯\\\_(ツ)_/¯
+
+## Installation
+
+```bash
+go get git.ext.icikowski.pl/icikowski/ip-ddns@latest
+```
+
+## Configuration
+
+| Environment variable | Description |
+|-|-|
+| `SYNCER_DA_URL` | DirectAdmin panel URL (default: `https://s149.cyber-folks.pl:2223`) |
+| `SYNCER_DA_USER` | DirectAdmin panel username |
+| `SYNCER_DA_TOKEN` | DirectAdmin panel token |
+| `SYNCER_DOMAIN_SRC_NAME` | Source domain name (DDNS one) |
+| `SYNCER_DOMAIN_SRC_NAMESERVER` | Source nameserver (DDNS one) |
+| `SYNCER_DOMAIN_DST_NAME` | Destination domain name (DA one) |
+| `SYNCER_DOMAIN_DST_NAMESERVER` | Destination nameserver (DA one) |
+| `SYNCER_DOMAIN_ENTRY_DN` | Entry domain name (from domains configured in DA) |
+| `SYNCER_DOMAIN_ENTRY_NAME` | Entry name |
+| `SYNCER_DOMAIN_ENTRY_TTL` | Entry TTL (default: `60`) |
+| `SYNCER_RESYNC_TIME` | Resync time (default: `15m`) |
+
+## Working example
+
+![Screenshot](_assets/service.png)
diff --git a/_assets/service.png b/_assets/service.png
new file mode 100644
index 0000000..8abedba
Binary files /dev/null and b/_assets/service.png differ