summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorsotrali <vesspa0330@gmail.com>2026-04-16 18:09:37 -0500
committersotrali <vesspa0330@gmail.com>2026-04-16 18:09:37 -0500
commit0eb4e9f9930d9783ee743deff7a15f2ac1d6c741 (patch)
treea49fadca2d094041105a4b2d0e7894024b951e10 /README.md
parent071c8f3d9724b9f4af5fec7cc77edce78e0b8b26 (diff)
updated README
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index fef2eaf..339ac32 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,15 @@
# Dynamic DNS Client for Porkbun API
A simple program for keeping all of your A records up to date!
+
Written in Go with only the standard library.
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