better readme

Author: TobiasKrais

README.md

@@ -1,2 +1,16 @@
-# d2u_guestbook
-Gästebuch für Redaxo 5
+# Gästebuch für Redaxo 5
+
+Demowebseite: <https://test.design-to-use.de/de/addontests/d2u-gaestebuch/>.
+
+Schritte zur Installation
+
+1. Einstellungen festlegen.
+2. Beispielmodul installieren oder eigenes Modul verwenden.
+
+Ein Gästebucheintrag wird nicht automatisch online gestellt. Nach einem neuen Gästebucheintrag wird eine E-Mail an die in den Einstellungen hinterlegte E-Mail-Adresse geschickt. Nach Prüfung muss der Gästebucheintrag in Redaxo manuell freigeschaltet werden.
+
+Es stehen mehrere Beispielmodule auf Basis von Bootstrap 4 zur Verfügung:
+
+- 60-1 D2U Guestbook - Gästebuch mit Bootstrap 4 Tabs: ermöglicht die Anzeige und das Schreiben von Gästebucheinträgen. Dabei werden die Gäastebucheinträge paginiert.
+- 60-2 D2U Guestbook - Infobox Bewertung: zeigt den Durchschnittswert des im Gästebuch vergebenen Ratings an.
+- 60-3 D2U Guestbook - Gästebuch ohne Tabs: ähnlich wie Modul 60-1, nur ohne Tabs

help.php

@@ -1,8 +1,5 @@
-<b>D2U Gästebuch</b>
-
-<br /><br />
-<p>Kleines Gästebuch. Besucher können eine Nachricht hitnerlassen, eine Bewertung
-	und ob sie eine Empfehlung aussprechen.</p>
-<p>Ein Modul gibt das Gästebuch aus und erlaubt neue Einträge. Ein zweites Modul
-	zeigt das Rating an.</p>
-<p>Beispielseite: <a href="http://www.immobiliengaiser.de">www.immobiliengaiser.de</a></p>
+<?php
+$readmePath = rex_path::addon('d2u_guestbook', 'README.md');
+$readmeContent = rex_file::get($readmePath);
+$readmeHtml = rex_markdown::factory()->parse($readmeContent);
+echo $readmeHtml;

install.php

@@ -28,10 +28,10 @@
         14);
     $modules[] = new D2UModule('60-2',
         'D2U Guestbook - Infobox Bewertung',
-        3);
+        4);
     $modules[] = new D2UModule('60-3',
         'D2U Guestbook - Gästebuch ohne Tabs',
-        10);
+        11);
     $d2u_module_manager = new D2UModuleManager($modules, '', 'd2u_guestbook');
     $d2u_module_manager->autoupdate();
 }

lib/d2u_guestbook_module_manager.php

@@ -18,10 +18,10 @@ public static function getModules()
             14);
         $modules[] = new D2UModule('60-2',
             'D2U Guestbook - Infobox Bewertung',
-            3);
+            4);
         $modules[] = new D2UModule('60-3',
             'D2U Guestbook - Gästebuch ohne Tabs',
-            10);
+            11);
         return $modules;
     }
 }

pages/setup.php

@@ -57,8 +57,9 @@
 <h2>Support</h2>
 <p>Fehlermeldungen bitte im <a href="https://github.com/TobiasKrais/d2u_guestbook" target="_blank">GitHub Repository</a> melden.</p>
 <h2>Changelog</h2>
-<p>1.0.11-DEV:</p>
+<p>1.0.11:</p>
 <ul>
+	<li>Readme Datei überarbeitet.</li>
 	<li>Restliche rexstan Verbesserungen.</li>
 	<li>Modul "60-1 D2U Guestbook - Gästebuch mit Bootstrap 4 Tabs": Einige CSS auf Modul beschränkt und Bugfix Paginierung.</li>
 </ul>