summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md23
-rwxr-xr-xdynamic-ddnsbin9184306 -> 0 bytes
2 files changed, 18 insertions, 5 deletions
diff --git a/README.md b/README.md
index 6974687..be91dcd 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,16 @@
# Dynamic DNS Client for Porkbun API
-To use, put binary in a folder with a file named ".env".
-The contents of the .env file should be JSON in the following format:
- ```{
+A simple program for keeping all of your A records up to date!
+
+To use, you will need your own Porkbun API key + secret.
+Then, place the `dynamic-dns` executable in a folder.
+Create a new file in the same folder named `.env`.
+Copy the text below into the `.env` file, replacing the example information with your own.
+
+Note: only include top-level domain, it'll take care of identifying and updating subdomain IPs
+
+```
+ {
"secretapikey": "XXXXXXXXXXXXX",
"apikey": "XXXXXXXXXXXXX",
"domains": [
@@ -10,6 +18,11 @@ The contents of the .env file should be JSON in the following format:
"example.net",
"example.io"
]
-}```
+}
+```
+
+You are now ready to run the program!
+
+I recommend scheduling the program with something like cron.
-Source Go code is included, I need to fix the package and stuff up though
+Source code is included, you can build it yourself if you want but the executable is up to date.
diff --git a/dynamic-ddns b/dynamic-ddns
deleted file mode 100755
index bcfe114..0000000
--- a/dynamic-ddns
+++ /dev/null
Binary files differ