cleanup, change documentation from binaries to markdown files

.gitattributes

@@ -1,5 +1,3 @@
 * text=auto !eol
-setup+doku/1_install.sql -text
-setup+doku/2_zuweisung.sql -text
-setup+doku/Installation.pdf -text
-sources/Inselzuschlag-Installation.docx -text
+1_install.sql -text
+2_zuweisung.sql -text

CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

README.en.md

@@ -0,0 +1,74 @@
+[![deutsche Version](https://logos.oxidmodule.com/de2_xs.svg)](README.md)
+[![english version](https://logos.oxidmodule.com/en2_xs.svg)](README.en.md)
+
+# Island assignments / island surcharges
+
+Modifies the country entries of the OXID eShop to enable shipping costs calculations to island territories.
+
+## Inhaltsverzeichnis
+
+- [Installation](#installation)
+- [Data customisation](#data-customisation)
+- [Rewrite previous customer data](#rewrite-previous-customer-data)
+- [Adjust settings](#adjust-settings)
+- [Notes](#notes)
+- [Extensibility](#extensibility)
+- [Changelog](#changelog)
+- [Contributing](#contributing)
+- [Licence](#licence)
+
+## Installation
+
+This package requires an installed OXID eShop.
+
+Execute the file `1_install.sql` in your shop database.
+
+## Data customisation
+
+In the database table `d3isles` you will now find the most common postcodes for which special treatment of the delivery is normally provided (e.g. price increases due to island surcharge). Add postcodes not yet included in this table or delete extra entries. (An editing option in the admin area is currently not provided for this).
+
+## Rewrite previous customer data
+
+In order to assign existing customer accounts to the newly available island areas, please additionally execute the file `2_zuordnung.sql` in your shop database.
+
+## Adjust settings
+
+Finally, adjust your shipping settings separately for mainland and islands and the respective country and configure the "new" country if required.
+
+## Notes
+
+Note that mainlanders and islanders are now seen as residents of two different countries in the shop. It is possible that statistics or plugins that require a unique country will no longer fit. However, this change has no effect on normal operation.
+
+This package does not contain any logic-changing scripts. If an island address is incorrectly assigned to the mainland by the shop customer, this is not automatically fixed. It is possible that inappropriate shipping costs will then be charged. Run the '2_assignment.sql' file automatically on a regular basis to keep stock account assignments up to date. Ad hoc corrections can be developed based on the data contained here.
+
+## Extensibility
+
+The database changes are designed so flexibly that the entries can also be used for any other country with corresponding special features apart from Germany. The only condition is that the selection can be made via the postcode (or a derivative thereof).
+Then, for your entries in the table `d3isles`, change the contents to `oxcountryid` (country of origin) and `oxislescountry` (new country of assignment). Create the additional country according to the default for Germany in the country table. Then run the file `2_zuweisung.sql` again.
+
+## Changelog
+
+See [CHANGELOG](CHANGELOG.md) for further informations.
+
+## Contributing
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!
+
+- Fork the Project
+- Create your Feature Branch (git checkout -b feature/AmazingFeature)
+- Commit your Changes (git commit -m 'Add some AmazingFeature')
+- Push to the Branch (git push origin feature/AmazingFeature)
+- Open a Pull Request
+
+## Licence
+(status: 2013-08-21)
+
+Distributed under the GPLv3 license.
+
+```
+Copyright (c) D3 Data Development (Inh. Thomas Dartsch)
+
+This software is distributed under the GNU GENERAL PUBLIC LICENSE version 3.
+```
+
+For full copyright and licensing information, please see the [LICENSE](LICENSE.md) file distributed with this source code.

README.md

@@ -1,4 +1,74 @@
-inselzuschlag
-=============
+[![deutsche Version](https://logos.oxidmodule.com/de2_xs.svg)](README.md)
+[![english version](https://logos.oxidmodule.com/en2_xs.svg)](README.en.md)
 
-makes price increase for delivery to isles available in OXID eShop
+# Inselzuordnungen / Inselzuschläge
+
+Verändert die Ländereinträge des OXID eShops, um Versandkostenberechnungen zu Inselgebieten zu ermöglichen.
+
+## Inhaltsverzeichnis
+
+- [Installation](#installation)
+- [Datenanpassung](#datenanpassung)
+- [bisherige Kundendaten umschreiben](#bisherige-kundendaten-umschreiben)
+- [Einstellungen anpassen](#einstellungen-anpassen)
+- [Hinweise](#hinweise)
+- [Erweiterbarkeit](#erweiterbarkeit)
+- [Changelog](#changelog)
+- [Beitragen](#beitragen)
+- [Lizenz](#lizenz)
+
+## Installation
+
+Dieses Paket erfordert einen installierten OXID eShop.
+
+Führen Sie die Datei `1_install.sql` in Ihrer Shopdatenbank aus.
+
+## Datenanpassung
+
+In der Datenbanktabelle `d3isles` finden Sie nun die gängigsten Postleitzahlen, für die normalerweise eine besondere Behandlung der Lieferung vorgesehen ist (z.B. Preiserhöhungen durch Inselzuschlag). Tragen Sie in dieser Tabelle noch nicht enthaltene Postleitzahlen nach oder löschen Sie überzählige Einträge. (Eine Bearbeitungsmöglichkeit im Adminbereich ist dafür derzeit nicht vorgesehen.)
+
+## bisherige Kundendaten umschreiben
+
+Um bestehende Kundenkonten zu den neu verfügbaren Inselgebieten zuzuordnen, führen Sie bitte zusätzlich die Datei `2_zuordnung.sql` in Ihrer Shopdatenbank aus.
+
+## Einstellungen anpassen
+
+Passen Sie abschließend Ihre Versandeinstellungen getrennt nach Festland und Inseln und dem jeweiligen Land an und konfigurieren Sie bei Bedarf das „neue“ Land.
+
+## Hinweise
+
+Beachten Sie, dass nun Festlandbewohner und Inselbewohner im Shop als Bewohner zweier unterschiedlicher Länder gesehen werden. Möglicherweise passen nun Auswertungen oder Modulerweiterungen nicht mehr, die ein eindeutiges Land erfordern. Für den Normalbetrieb hat diese Änderung jedoch keine Auswirkung.
+
+Dieses Paket enthält keine logikverändernden Skripte. Wird eine Inseladresse vom Shopkunden fälschlicherweise zum Festland zugeordnet, wird dies nicht automatisch korrigiert. Möglicherweise werden dann unpassende Versandkosten berechnet. Führen Sie die Datei `2_zuordnung.sql` regelmäßig automatisiert aus, um die Zuordnungen der Bestandskonten aktuell zu halten. Adhoc-Korrekturen können auf Basis der hier enthaltenen Daten entwickelt werden.
+
+## Erweiterbarkeit
+
+Die Datenbankänderungen sind so flexibel angelegt, dass die Einträge außer für Deutschland auch für jedes andere Land mit entsprechenden Besonderheiten genutzt werden können. Einzige Bedingung ist, dass die Selektion über die Postleitzahl (oder
+ein Derivat derer) erfolgen kann. Ändern Sie dann für Ihre Einträge in der Tabelle `d3isles` die Inhalte in `oxcountryid` (Ursprungsland) und `oxislescountry` (neues Land der Zuweisung). Legen Sie das zusätzliche Land entsprechend der Vorgabe für Deutschland in der Ländertabelle an. Führen Sie dann die Datei `2_zuweisung.sql` erneut aus.
+
+## Changelog
+
+Siehe [CHANGELOG](CHANGELOG.md) für weitere Informationen.
+
+## Beitragen
+
+Wenn Sie eine Verbesserungsvorschlag haben, legen Sie einen Fork des Respoitories an und erstellen Sie einen Pull Request. Alternativ können Sie einfach ein Issue erstellen. Fügen Sie das Projekt zu Ihren Favoriten hinzu. Vielen Dank.
+
+- Erstellen Sie einen Fork des Projekts
+- Erstellen Sie einen Feature Branch (git checkout -b feature/AmazingFeature)
+- Fügen Sie Ihre Änderungen hinzu (git commit -m 'Add some AmazingFeature')
+- Übertragen Sie den Branch (git push origin feature/AmazingFeature)
+- Öffnen Sie einen Pull Request
+
+## Lizenz
+(Stand: 21.08.2013)
+
+Vertrieben unter der GPLv3 Lizenz.
+
+```
+Copyright (c) D3 Data Development (Inh. Thomas Dartsch)
+
+Diese Software wird unter der GNU GENERAL PUBLIC LICENSE Version 3 vertrieben.
+```
+
+Die vollständigen Copyright- und Lizenzinformationen entnehmen Sie bitte der [LICENSE](LICENSE.md)-Datei, die mit diesem Quellcode verteilt wurde.