summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9d05bf3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# 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:
+ ```{
+ "secretapikey": "XXXXXXXXXXXXX",
+ "apikey": "XXXXXXXXXXXXX",
+ "domains": [
+ "example.com",
+ "example.net",
+ "example.io"
+ ]
+}```