readme hinzugefügt

readme

@@ -0,0 +1,20 @@
+# OMEM-Gallery
+
+Bilder-Galerie und -Slider für den Alamos Alarmmonitor des THW OV Memmingen  
+
+## Getting Started
+
+Dieser Code bietet eine API auf Basis von Express.JS
+
+Für den Abruf gibt es mehrere URLs:
+- /getonepic -> Diashow-Modus für ein einzelnes Bild, das sich über einen Refresh-Header nach 10 Sekunden neulädt und das nächste Bild der Liste anzeigt. Über einen Session-Key wird sichergestellt, dass jeder Client die Liste unabhängig durchrotiert.
+- /getonepic-norefresh -> Diashow-Modus ohne automatischen Refresh. Zeigt bei jedem Aufruf ein anderes Bild. Ebenfalls mit Session-Key
+- /get4pic/[ID] -> Raster-Modus für jede Id wird ein festgelegtes Bild ausgegeben, das dann bspw. auf einem 2x2 Raster in einem Frontend dargestellt werden kann
+
+
+Die Ports lassen sich über die .env Datei ändern.
+Die API ist für den Betrieb hinter einem Reverse-Proxy ausgelegt.
+
+Um die Bilder zu ändern, gibt es 2 Unterordner im Ordner "uploaded":
+- /slider/ für die Diashow. Die Namensgebung ist irrelevant, jedoch muss es jpg oder png sein. Die Liste aktualisiert sich automatisch beim nächsten Refresh.
+- /4pic/ für das 2x2 Raster, dessen 4 Bilder jeweils nach dem Format "<ID>.jpg" bzw. "<ID>.png" benannt werden müssen.