summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.md b/README.md
index 7a57ea7..d77fb51 100644
--- a/README.md
+++ b/README.md
@@ -2,17 +2,15 @@
A simple program for keeping all of your "A" records up to date!
+To use, you will first need your own Porkbun API key + secret.
+Once you know your key+secret, download and place the `porkbun-ddns` executable in a folder.
-To use, you will need your own Porkbun API key + secret.
+Create a new file in the same folder, and name it `.env`.
-Then, place the `porkbun-ddns` executable in a folder.
+Copy the text below into the `.env` file, replacing the XXX's and example domains with your own information.
-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
+Note: only include top-level domains, the program will take care of identifying and updating any sub-domains
```
{
@@ -26,8 +24,10 @@ Note: only include top-level domain, it'll take care of identifying and updating
}
```
-You are now ready to run the program!
+You are now ready to run the program! Running it will retreive all "A" records belonging to the domains you specified, then update any outdated IP addresses.
+
+I recommend scheduling the program with something like cron so that you aren't manually running it each time you want to update your DNS information.
-I recommend scheduling the program with something like cron.
+Source code is included, you can build it yourself if you want but the executable is up to date.
-Source code is included, you can build it yourself if you want but the executable is up to date. This program was written with only the standard library, in Vim :)
+This program was written in Vim with only the Go standard library, if that means anything to you..