initial commit

1 files changed, 8 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eee7298
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# zoner
+declarative dns management for porkbun
+
+# configuration
+create porkbun api credentials and insert them into `~/.config/zoner/zoner.toml` like in [example/zoner.toml](example/zoner.toml). then just run `zoner <domain>`, insert your data in the same format as [example/example.com.zone](example/example.com.zone). note that you need tabs between values, not spaces, but you can repeat tabs as much as you'd like
+
+# hook
+see [example/hook](example/hook) for an example hook that automatically purges dns entries from cloudflare