From 3354a7d5f2353e95fd970a3e3e6b7d663316186e Mon Sep 17 00:00:00 2001
From: Jan Speller <j-speller@outlook.com>
Date: Mon, 1 Mar 2021 08:13:26 +0100
Subject: [PATCH] add documentation

---
 docu/docs/plugin/mysql.md | 42 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 docu/docs/plugin/mysql.md

diff --git a/docu/docs/plugin/mysql.md b/docu/docs/plugin/mysql.md
new file mode 100644
index 0000000..0497aeb
--- /dev/null
+++ b/docu/docs/plugin/mysql.md
@@ -0,0 +1,42 @@
+# <center>Mysql</center> 
+---
+
+## Beschreibung
+Mit diesem Plugin ist es moeglich, die Alarmierungen in einer Mysql / Mariadb Datenbank zu speichern.
+
+## Unterstütze Alarmtypen
+- Fms
+- Pocsag
+- Zvei
+- Msg
+
+## Resource
+`mysql`
+
+## Konfiguration
+|Feld|Beschreibung|Default|
+|----|------------|-------|
+|host|IP-Adresse bzw. URL des Hosts||
+|user|Username||
+|password|Passwort||
+|database|Name der Datenbank||
+
+**Beispiel:**
+```yaml
+  - type: plugin
+    name: mysql
+    res: mysql
+    config:
+      host: HOST
+      user: USERNAME
+      password: PASSWORD
+      database: DATABASE
+```
+
+---
+## Modul Abhängigkeiten
+- keine
+
+---
+## Externe Abhängigkeiten
+- mysql-connector-python