From 7b8cd520efb2903d6b7d5ab23abad24b4053a116 Mon Sep 17 00:00:00 2001
From: Julian Lobbes <julian.lobbes@protonmail.com>
Date: Fri, 2 Sep 2022 22:03:19 +0200
Subject: [PATCH] docs: add `domains.json` example and explanation

---
 README.md    | 19 +++++++++++++++++++
 domains.json |  8 ++++++++
 2 files changed, 27 insertions(+)
 create mode 100644 domains.json

diff --git a/README.md b/README.md
index 2841606..47c7656 100644
--- a/README.md
+++ b/README.md
@@ -25,3 +25,22 @@ apikey:
 
 ...
 ```
+
+### Adding target domains
+
+Add every domain you want to send an update for to the file `domains.json`.
+The file should list each domain whose global DNS record should point to the local host's public IP.
+The file must have the following format:
+
+```json
+{
+  "domains": [
+    "example.com",
+    "subdomain1.example.com",
+    "subdomain2.example.com",
+  ],
+  "description": "My dynamic DNS."
+}
+```
+
+The description can have any string as a value, but it must be present.
diff --git a/domains.json b/domains.json
new file mode 100644
index 0000000..eafbd85
--- /dev/null
+++ b/domains.json
@@ -0,0 +1,8 @@
+{
+  "domains": [
+    "example.com",
+    "subdomain1.example.com",
+    "subdomain2.example.com",
+  ],
+  "description": "My dynamic DNS."
+}