summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorsotrali <vesspa0330@gmail.com>2026-04-16 18:07:50 -0500
committersotrali <vesspa0330@gmail.com>2026-04-16 18:07:50 -0500
commita34df2d7e8abea44a0773dd9bbc0eacaa711a955 (patch)
treedacdcad47c41e402898d4e05150add183d588c9e /README.md
parent6ee8be706f441749417d67a2da17c8a3c47802ed (diff)
removed old binary + updated README
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 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.