docs: add README.md

README.md

@@ -0,0 +1,34 @@
+# nyacme
+
+*a uacme wrapper that maybe probably doesn't suck too much*
+
+example configuration:
+```toml
+post_acquire = [
+	"doas service haproxy reload"
+]
+
+certificates = [
+	"ptrc.gay",
+	"*.dev.ptrc.gay"
+]
+
+[domains]
+"ptrc.gay" = "hetzner"
+
+[secrets]
+hetzner = "your_secret_goes_here"
+```
+
+configuration options:
+- `post_acquire` - list of commands to be ran after a new certificate is acquired
+- `certificates` - list of CNs for the desired certificates (note: `*.domain.tld` also adds a `domain.tld` CN)
+- `domains` - dict of domains and their respective providers (note: it is expected that a domain is also the root of the zone)
+- `secrets` - dict of secrets to be used by providers; *usually* with the same name as provider itself
+- `acme_path` - string, path to your `.well-known/acme-challenge/`
+
+currently implemented providers:
+- `cloudflare`
+- `hetzner`
+- `http`
+- `porkbun` (with secrets `porkbun.apikey` and `porkbun.secretapikey`)