From b9d95fa53141ec77f7c7dfb41189616b885d5be9 Mon Sep 17 00:00:00 2001
From: Johannes Przymusinski <johannes.przymusinski@jop-software.de>
Date: Tue, 2 Aug 2022 21:31:29 +0200
Subject: [PATCH] task: add examples

---
 README.md                    | 15 +++++++++++++++
 examples/docker-compose.yaml | 10 ++++++++++
 examples/imap-exporter.env   |  3 +++
 3 files changed, 28 insertions(+)
 create mode 100644 examples/docker-compose.yaml
 create mode 100644 examples/imap-exporter.env

diff --git a/README.md b/README.md
index f77a8fc..1fe8640 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,21 @@ http://127.0.0.1:9101/probe?mailbox=INBOX
 probe_mailbox_count 0
 ```
 
+### Example Usage
+
+You can find a example docker compose configuration.
+
+Make sure to update `examples/imap-exporter.env` with your imap credentials.
+
+**Start the example container**
+
+```shell
+pushd examples
+
+docker compose pull
+docker compose up -d
+```
+
 ## License
 
 This project is licensed under the [MIT License](./LICENCE)
diff --git a/examples/docker-compose.yaml b/examples/docker-compose.yaml
new file mode 100644
index 0000000..0f9c790
--- /dev/null
+++ b/examples/docker-compose.yaml
@@ -0,0 +1,10 @@
+version: "3"
+
+services:
+
+  imap-exporter:
+    image: "ghcr.io/jop-software/imap-mailbox-exporter:latest"
+    env_file:
+      - "imap-exporter.env"
+    ports:
+      - "9101:9101"
diff --git a/examples/imap-exporter.env b/examples/imap-exporter.env
new file mode 100644
index 0000000..1651b70
--- /dev/null
+++ b/examples/imap-exporter.env
@@ -0,0 +1,3 @@
+IMAP_SERVER=""
+IMAP_USERNAME=""
+IMAP_PASSWORD=""
\ No newline at end of file