From ea953bfe580714bd2ad0b03373639b002a00998d Mon Sep 17 00:00:00 2001
From: Tyler Murphy <tylerm@tylerm.dev>
Date: Tue, 12 Sep 2023 09:01:07 -0400
Subject: script

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e8c7160
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Cloudflare AutoDNS
+
+A bash script to update your dns (for cloudflare) for those who run servers with a dynamic IP
+
+## How to
+
+The following enviornment variables are to be set
+```
+1. API_TOKEN    Your cloudflare API token
+2. ZONE         The zone contaning the dns record
+3. DOMAIN       The domain record in the zone to be updated
+```
+This script is best used with a cron job
+
+## License
+
+This project is Licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html)
-- 
cgit v1.2.3-freya