From f7a1fe81439b9ca3eb7906007e9d56911982f305 Mon Sep 17 00:00:00 2001
From: David Kilias <david.kilias@gmail.com>
Date: Thu, 11 Feb 2021 23:25:37 +0100
Subject: [PATCH] add some documentation in README.md

---
 roles/dehydrated-domains/README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 roles/dehydrated-domains/README.md

diff --git a/roles/dehydrated-domains/README.md b/roles/dehydrated-domains/README.md
new file mode 100644
index 0000000..3da2197
--- /dev/null
+++ b/roles/dehydrated-domains/README.md
@@ -0,0 +1,17 @@
+# Dehydrated Domains
+
+Ansible role to configure domains for use with dehydrated
+
+## Usage
+
+```yaml
+vars:
+    dehydrated_domains:
+        name: example.com
+        deploy_challenge_hook: printf 'server 127.0.0.1\nupdate add _acme-challenge.%s 300 IN TXT "%s"\nsend\n' "${DOMAIN}" "${TOKEN_VALUE}" | nsupdate -k /var/run/named/session.key
+        clean_challenge_hook: printf 'server 127.0.0.1\nupdate delete _acme-challenge.%s TXT "%s"\nsend\n' "${DOMAIN}" "${TOKEN_VALUE}" | nsupdate -k /var/run/named/session.key
+
+roles:
+    - role: dehydrated-domains
+
+```
\ No newline at end of file