Add readme

1 files changed, 29 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ff4894e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# certbot-dns-cloudflare
+
+Wrapper of `geerlingguy.certbot` to generate certificates using DNS challenges and Cloudflare.
+
+##### requirements.yml
+
+```yaml
+roles:
+  - src: git+https://git.segundo.io/Ansible/certbot-dns-cloudflare
+    name: certbot-dns-cloudflare
+```
+
+## Example playbook
+
+See [`vars/main.yml`](/Ansible/etc-aliases/tree/vars/main.yml) & [`defaults/main.yml`](/Ansible/etc-aliases/tree/defaults/main.yml)
+
+```yaml
+---
+- hosts: foo
+  roles:
+    - role: certbot-dns-cloudflare
+      vars:
+        certbot_cloudflare_api_token: xxxxx
+        certbot_admin_email: foo@bar
+        certbot_certs:
+          - domains:
+              - "*.foo.bar"
+              - "foo.bar"
+```