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