From b63e7aa94ea8c2e65146b247ca85e17ae0d84b4d Mon Sep 17 00:00:00 2001
From: Thorsten <thorsten.seine@gmail.com>
Date: Sat, 21 Dec 2024 16:10:52 +0100
Subject: [PATCH] readme

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9e25c0e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Paperless-ngx Notification Script
+
+Dieses Bash-Skript sendet eine Benachrichtigung über `NTFY`, wenn ein neues Dokument im Consume-Ordner von Paperless-ngx hinzugefügt wurde.
+
+## Anforderungen
+- Ein ntfy-Server für das Senden von Benachrichtigungen
+
+## Verwendung
+
+### Konfigurationsdatei erstellen
+
+Platzieren Sie das Skript und eine .env-Datei im gleichen Verzeichnis. Die .env-Datei muss denselben Namen wie das Skript haben, jedoch mit der Endung `.env` (z. B. `sshell_ntfy_paperless.sh` und `shell_ntfy_paperless.env`).
+
+```bash
+# NTFY Server
+NTFY_URL=https://ntfy.server.net/
+AUTH_TOKEN=tk_elwqvm6niscdn30f45iksdfh6sope
+
+#Paperless-ngx Server
+PAPERLESS_URL=http://192.168.178.25:8200
+```
+
+### Konfiguration von Paperless-ngx
+
+1. Speichern sie das Skript und die gleichnamige `.env` Datei innerhalb Ihres Paperless Ordners 
+
+2. Geben Sie den Speicherort des Skripts bei Paperless-ngx als Variable an. In der Docker Compose z.B.:
+```bash
+PAPERLESS_POST_CONSUME_SCRIPT: /usr/src/paperless/scripts/shell_ntfy_paperless.sh
+```
+