feat: docs

README.md

@@ -6,16 +6,33 @@ Deploy certbot and enable auto-renew.
 Role Variables
 --------------
 
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+```yaml
+# certbot settings
+certbot_fqdn:
+  - example.de
+certbot_admin_email: "admin@example.de"
+# certbot_webroot: "/var/www/example"                          # if undefined use --standalone
+
+# application settings
+# certbot_application: "example"                               # if defined copy certs to application dir and setup deploy hooks
+certbot_application_dir: "/etc/{{ certbot_application }}"
+certbot_application_deploy_hook: |
+  #!/bin/sh
+
+  cp {{ certbot_live_dir }}/fullchain.pem {{ certbot_application_dir }}
+  cp {{ certbot_live_dir }}/privkey.pem {{ certbot_application_dir }}
+
+  systemctl restart {{ certbot_application }}.service
+```
 
 Example Playbook
 ----------------
 
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-
-    - hosts: servers
-      roles:
-         - { role: username.rolename, x: 42 }
+```yaml
+- hosts: all
+  roles:
+    - hdacloud.oauth2
+```
 
 License
 -------