From 058499f305de342be1be3d071edfa9baba6d6c7b Mon Sep 17 00:00:00 2001
From: Zoey <zoey@z0ey.de>
Date: Tue, 26 Mar 2024 18:09:52 +0100
Subject: [PATCH] Create README.md

Signed-off-by: Zoey <zoey@z0ey.de>
---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..77bf912
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# ipv64-updater
+
+just use this compose file:
+
+```yaml
+services:
+  ipv64-updater:
+    container_name: ipv64-updater
+    image: zoeyvid/ipv64-updater
+    restart: always
+    network_mode: host                       # you can use bridge if it support IPv6
+    environment:
+      - "TZ=Europe/Berlin"                     # your timezone
+      - "DUK=r23jLIKr6IQwrlU6Wcv4ZxrJePxbd57t" # your Domain Update Token (invalid example)
+#      - "UI=5m"                               # interval to update DDNS
+#      - "IPv4=true"                           # enable/disable IPv4
+#      - "IPv6=true"                           # enable/disable IPv6
+```