From 109d64299e7adef157a28be87e0a23b3848a0b24 Mon Sep 17 00:00:00 2001
From: alf <service@wralto.org>
Date: Thu, 9 Oct 2025 11:50:49 +0000
Subject: [PATCH] =?UTF-8?q?README.md=20hinzugef=C3=BCgt?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f4d4f7c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,81 @@
+# Internetverbindungs-Testskript
+
+Dieses Bash-Skript überwacht die Internetverbindung über einen festgelegten Zeitraum und protokolliert den Status in einer Logdatei.
+
+---
+
+## Beschreibung
+
+Das Skript führt alle 20 Sekunden einen Ping-Test gegen die IP-Adresse `8.8.8.8` (Google DNS) durch. Es läuft für insgesamt 20 Minuten und protokolliert, ob die Internetverbindung aktiv ist oder nicht. Die Logs werden in einer separaten Datei gespeichert.
+
+---
+
+## Voraussetzungen
+
+- Bash-Umgebung (Linux/Unix/MacOS)
+- `ping`-Befehl muss verfügbar sein
+- Gitea-Ordnerstruktur mit Logger-Funktionen (siehe [Logger](#logger))
+- Schreibrechte im Log-Verzeichnis
+
+---
+
+## Installation
+
+1. Skript in eine Datei, z.B. `vieruhrtest.sh`, speichern.
+2. Ausführbar machen:
+   ```bash
+   chmod +x vieruhrtest.sh
+   ```
+3. Gitea-Logger-Struktur anpassen:
+   - Der Pfad `$HOME/Gitea/logger/logger.sh` muss existieren und die Funktionen `log_init`, `log_start`, `log_info`, `log_warn` und `log_end` bereitstellen.
+   - Das Log-Verzeichnis `$HOME/Gitea/logger/Logs/` muss existieren und beschreibbar sein.
+
+---
+
+## Nutzung
+
+```bash
+./vieruhrtest.sh
+```
+
+Das Skript läuft automatisch für 20 Minuten und beendet sich danach selbst.
+
+---
+
+## Konfiguration
+
+| Variable        | Beschreibung                                      | Standardwert |
+|-----------------|--------------------------------------------------|--------------|
+| `DURATION`      | Gesamtdauer des Tests in Sekunden                | 1200         |
+| `INTERVAL`      | Intervall zwischen den Tests in Sekunden         | 20           |
+| `TARGET_IP`     | IP-Adresse zum Pingen                             | 8.8.8.8      |
+
+---
+<a name="logger"></a>
+
+## Logger
+
+Das Skript nutzt eine externe Logger-Bibliothek (`logger.sh`), die folgende Funktionen bereitstellen muss:
+
+- `log_init $LOGBUCH`: Initialisiert das Logfile
+- `log_start`: Startet die Protokollierung
+- `log_info "Nachricht"`: Loggt eine Informationsmeldung
+- `log_warn "Nachricht"`: Loggt eine Warnmeldung
+- `log_end`: Beendet die Protokollierung
+
+---
+## Beispiel-Logausgabe
+
+```
+2025-10-09 14:00:00: ✅ Internetverbindung ist aktiv.
+2025-10-09 14:00:20: ❌ Keine Internetverbindung gefunden.
+2025-10-09 14:00:40: ✅ Internetverbindung ist aktiv.
+```
+
+---
+## Lizenz
+
+[MIT](https://opensource.org/licenses/MIT)
+```
+
+---
\ No newline at end of file