readme updated

README.md

@@ -1,19 +1,35 @@
-TPL Development Helper
-======================
+# TPL Development Helper
+### Entwicklungswerkzeug zur Kontrolle schwer zug<75>nglicher Shopinhalte
 
-Das Tool soll bei t<>glichen Entwicklungsaufgaben im OXID eShop helfen, die (systembedingt) vom Shopsystem erschwert werden.
+Diese Tool soll bei t<>glichen Entwicklungsaufgaben im OXID eShop helfen, die (systembedingt) vom Shopsystem erschwert werden.
 
 * Mailversand (<28>bers Shopframework) <20>bers Shopframework wird blockiert __oder__
 * Mails (<28>bers Shopframework) werden an alternative Mailadresse umgeleitet
     (Das Tool setzt direkt an der oxemail::_sendMail()-Methode an und kann damit __jeden__ Mailversand kontrollieren, der <20>bers Framework l<>uft. Man muss nicht X verschiedene Module <20>berwachen und hat auch Kontrolle <20>ber Mailerweiterungen, die keinen Stage-Einsatz vorsehen.)
+* unterbindet das L<>schen des Warenkorbs nach Bestellabschluss
+* Thankyou-Seite ist auch ohne Bestellabschluss aufrufbar (unter Angabe der Bestellnummer auch f<>r eine bestimmte Bestellung)
+* Bestellbest<73>tigungsmails und sind im Browser darstellbar (unter Angabe der Bestellnummer auch f<>r eine bestimmte Bestellung)
 
-- unterbindet das L<>schen des Warenkorbs nach Bestellabschluss
-- Thankyou-Seite ist auch ohne Bestellabschluss aufrufbar (unter Angabe der Bestellnummer auch f<>r eine bestimmte Bestellung)
-- Bestellbest<73>tigungsmails und sind im Browser darstellbar (unter Angabe der Bestellnummer auch f<>r eine bestimmte Bestellung)
+__Da hiermit gezielt Mails der Shopbestellungen angezeigt werden k<>nnen, ist das Modul mit <20>u<EFBFBD>erster Vorsicht zu verwenden. Die H<>rden f<>r die Anzeige der Mails sind daher absichtlich sehr hoch gesetzt. Vor der Verwendung sind Einstellungen zu <20>ndern. Denken Sie unbedingt daran, diese Einstellungen im Anschluss wieder zur<75>ckzusetzen. Sonst sind Kunden- und Bestelldaten frei abrufbar. Wir <20>bernehmen f<>r daraus resultierenden Sch<63>den keine Haftung.__
 
-Hinweise zur Benutzung und Konfiguration sind in der Metadata-Modulbeschreibung enthalten.
-Diese k<>nnen nach Installation im Backend des OXID-Shops unter "Erweiterungen -> Module" eingesehen werden.
+Um unser Tool verwenden zu k<>nnen, folgen Sie bitte diesen Schritten:
 
-Alle Optionen sind einzeln aktivierbar. Der Shop darf nicht im Produktivmodus laufen.
+1. Produktivmodus entfernen
 
-__Da das Modul einige Sicherheitsmechanismen des Shops deaktiviert, ist bei einem Einsatz in von extern erreichbaren Systemen besondere Vorsicht n<>tig!__
+   ![Adminbereich -> Stammdaten -> Grundeinstellungen -> Haken bei Produktivmodus entfernen](step1.jpg "Produktivmodus entfernen")
+
+2. Modul aktivieren
+
+   ![Adminbereich -> Erweiterungen -> Module -> TPL Development Tool -> Aktivieren](step2.jpg "Modul aktivieren")
+   
+3. In den Einstellungen die gew<65>nschten Funktionen freischalten
+
+   ![Adminbereich -> Erweiterungen -> Module -> TPL Development Tool -> Einstell.](step3.jpg "gew<65>nschte Funktionen freischalten")
+   
+4. <20>ber die Links im Tab <20>Stamm<6D> k<>nnen Sie die betreffenden Seiten aufrufen. Vor der Darstellung wird ein Benutzername und Passwort abgefragt. Hierf<72>r verwenden Sie die Anmeldedaten des Abminbereichs Ihres Shops.
+
+5. An den E-Mail- und Thankyou-Links gibt es einen leeren Parameter, den Sie bei Bedarf mit einer Bestellnummer f<>llen k<>nnen. Dann wird statt der letzten Bestellung ganz gezielt eine andere Bestellung zur Darstellung verwendet.
+
+6. Beachten Sie unbedingt, dass Sie nach der Verwendung unbedingt das Modul wieder deaktivieren und den Produktivmodus wieder anschalten.
+
+Ber<EFBFBD>cksichtigen Sie bei der Darstellung der E-Mails bitte, dass die Mailprogramme diese m<>glicherweise anders darstellen, als der Browser dies tut. Daher kann die Darstellung im Browser nur ein Anhaltspunkt sein.