From 4efafee9919560023415f0ee1037fc3204cec7d3 Mon Sep 17 00:00:00 2001 From: Sunnyka <71286632+Sunnyka98@users.noreply.github.com> Date: Wed, 19 Apr 2023 11:38:20 +0200 Subject: [PATCH 1/3] migrate tests to v10 --- .gitignore | 4 ++++ ...onTest.php => CountdownValidationTest.php} | 0 tests/phpunit.xml | 21 ++++++++++--------- 3 files changed, 15 insertions(+), 10 deletions(-) create mode 100644 .gitignore rename tests/{CoundownValidationTest.php => CountdownValidationTest.php} (100%) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c013e4b --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.DS_Store +.idea/ +.phpunit.* +.php_cs.cache \ No newline at end of file diff --git a/tests/CoundownValidationTest.php b/tests/CountdownValidationTest.php similarity index 100% rename from tests/CoundownValidationTest.php rename to tests/CountdownValidationTest.php diff --git a/tests/phpunit.xml b/tests/phpunit.xml index abbf25a..9a4c075 100644 --- a/tests/phpunit.xml +++ b/tests/phpunit.xml @@ -1,11 +1,12 @@ - - - - - - - ../Countdown - - - \ No newline at end of file + + + + + + + + ../Countdown + + + From 7b3b74c0a4b32604ebc767bdf6eebc37f027a6bb Mon Sep 17 00:00:00 2001 From: Sunnyka <71286632+Sunnyka98@users.noreply.github.com> Date: Wed, 19 Apr 2023 11:38:40 +0200 Subject: [PATCH 2/3] reference documentation to site --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c9dbd5f..a835af9 100644 --- a/README.md +++ b/README.md @@ -6,5 +6,5 @@ Folgende Module beinhaltet das Countdown Repository: -- __Countdown__ ([Dokumentation](Countdown)) +- __Countdown__ ([Dokumentation](https://www.symcon.de/de/service/dokumentation/modulreferenz/countdown)) Das Modul ermöglicht es einen Countdown bis zu einem Event im Webfront anzuzeigen. From bd48a6e8e9487c42d01b4c71b8cce27fb0d863e3 Mon Sep 17 00:00:00 2001 From: Sunnyka <71286632+Sunnyka98@users.noreply.github.com> Date: Tue, 19 Sep 2023 09:18:25 +0200 Subject: [PATCH 3/3] redirect readme --- Countdown/README.md | 62 ++------------------------------------------- 1 file changed, 2 insertions(+), 60 deletions(-) diff --git a/Countdown/README.md b/Countdown/README.md index 358e462..62c8126 100644 --- a/Countdown/README.md +++ b/Countdown/README.md @@ -1,63 +1,5 @@ # Countdown -Das Modul ermöglicht es einen Countdown bis zu einem Event im Webfront anzuzeigen. - -### Inhaltverzeichnis - -1. [Funktionsumfang](#1-funktionsumfang) -2. [Voraussetzungen](#2-voraussetzungen) -3. [Software-Installation](#3-software-installation) -4. [Einrichten der Instanzen in IP-Symcon](#4-einrichten-der-instanzen-in-ip-symcon) -5. [Statusvariablen und Profile](#5-statusvariablen-und-profile) -6. [WebFront](#6-webfront) -7. [PHP-Befehlsreferenz](#7-php-befehlsreferenz) - -### 1. Funktionsumfang - -* Ermöglicht es einen Countdown im Webfront anzuzeigen, der sich minütlich aktualisiert -* Festlegung eines Zeitpunktes und Namen eines Ereignis - -### 2. Voraussetzungen - -- IP-Symcon ab Version 5.0 - -### 3. Software-Installation - -* Über den Modul Store das Modul Countdown installieren. -* Alternativ über das Modul Control folgende URL hinzufügen: -`https://github.com/symcon/Countdown` - -### 4. Einrichten der Instanzen in IP-Symcon - -- Unter "Instanz hinzufügen" kann das 'Countdown'-Modul mithilfe des Schnellfilters gefunden werden. - - Weitere Informationen zum Hinzufügen von Instanzen in der [Dokumentation der Instanzen](https://www.symcon.de/service/dokumentation/konzepte/instanzen/#Instanz_hinzufügen) - -__Konfigurationsseite__: - -Name | Beschreibung ------------------ | ------------------------------------- -Datum und Uhrzeit | Datum und Uhrzeit -Ereignis | Name der Im WebFront angezeigt werden soll - - -### 5. Statusvariablen und Profile - -Die Statusvariablen/Kategorien werden automatisch angelegt. Das Löschen einzelner kann zu Fehlfunktionen führen. - -##### Statusvariablen - -Name | Typ | Beschreibung ------------------ | ------- | -------------------------------- -Ereignis erreicht | Boolean | Zeigt an ob das Ereignis erreicht wurde -Verbleibende Zeit | String | Beinhaltet die verbleibende Zeit - -##### Profile: - -Es werden keine neuen Profile erstellt. - -### 6. WebFront - -Hier wird der Countdown angezeit und, sowie eine Nachricht, wenn das Ereignis eingetreten ist. - -### 7. PHP-Befehlsreferenz +[Link zur deutschen Dokumentation](https://www.symcon.de/de/service/dokumentation/modulreferenz/countdown/) +[Link to the english documentation](https://www.symcon.de/en/service/documentation/module-reference/countdown/) \ No newline at end of file