From aeefc2a763450dbc0b7eb08acf5da6f4f2dbdb5e Mon Sep 17 00:00:00 2001
From: phil <phil@systemausfall.org>
Date: Wed, 1 Mar 2023 13:32:51 +0100
Subject: [PATCH] Add configuration example

---
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f6d42a5..ee89747 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,37 @@
 DIUN - Docker Image Update Notifier
 ===================================
 
-This role installs [Duin](https://crazymax.dev/diun/).
+This role installs [Duin](https://crazymax.dev/diun/). Configuration is done via your `host_vars` files:
+
+```YAML
+diun_watch:
+  config: |
+    workers: 10
+    schedule: "0 */6 * * *"
+    jitter: 30s
+    firstCheckNotif: false
+
+diun_notif:
+  - name: mail
+    config: |
+      host: localhost
+      port: 25
+      ssl: false
+      insecureSkipVerify: false
+      from: diun@example.org
+      to:
+        - admin@example.org
+
+diun_providers:
+  - name: docker
+    config: |
+      watchByDefault: true
+      watchStopped: true
+      endpoint: "unix:///run/docker.sock"
+  - name: file
+    config: |
+      filename: {{ diun_configuration_path }}/{{ diun_provider_image_file }}
+
+diun_provider_images:
+  - name: docker.io/discourse/base:release
+```