update module informations

CHANGELOG.md

@@ -4,27 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://git.d3data.de/D3Public/MyModule/compare/1.1.0.0...rel_1.x)
+## [Unreleased](https://git.d3data.de/D3Public/MyModule/compare/1.0.0.0...rel_1.x)
 
-## [1.1.0.0](https://git.d3data.de/D3Public/MyModule/compare/1.0.0.0...1.1.0.0) - 2022-07-26
+## [1.0.0.0](https://git.d3data.de/D3Public/MailConfigChecker/releases/tag/1.0.0.0) - 2023-12-13
 ### Added
-- another feature
+- Checking the mail configuration
-
+- Checking the transmission path used
-### Changed
+- SMTP connection analysis
-- changed old code
+- SPF header check
-
+- Test mail dispatch
-### Deprecated
-- ...
-
-### Removed
-- ...
-
-### Fixed
-- ...
-
-### Security
-- ...
-
-## [1.0.0.0](https://git.d3data.de/D3Public/MyModule/releases/tag/1.0.0.0) - 2022-07-25
-### Added
-- implemented features

README.en.md

@@ -1,9 +1,7 @@
 [![deutsche Version](https://logos.oxidmodule.com/de2_xs.svg)](README.md)
 [![english version](https://logos.oxidmodule.com/en2_xs.svg)](README.en.md)
 
-# D³ Modulname for OXID eShop
+# D³ Mail Configuration Check for OXID eShop
-
-Insert short description here
 
 ## Table of content
 
@@ -12,35 +10,22 @@ Insert short description here
 - [Changelog](#changelog)
 - [Contributing](#contributing)
 - [License](#license)
-- [Further licences and terms of use](#further-licences-and-terms-of-use)
 
 ## Installation
 
 This package requires an OXID eShop installed with Composer in a version defined in the [composer.json](composer.json).
 
-Please enter the following section in the `composer.json` of your project:
-
-```
-  "extra": {
-    optional instructions from 3rd party packages (e.g. patch or symlink instructions)
-  }
-```
-
 Open a command line and navigate to the root directory of the shop (parent directory of source and vendor). Execute the following commands. Adapt the path details to your installation environment.
 
 ```bash
-composer require d3/modulename:^2.0
+composer require d3/mailconfigchecker:^1.0
-
-./vendor/bin/oe-eshop-db_migrate migrations:migrate modulemetadataid
 ``` 
 
-If necessary, please confirm that you allow `package-name` to execute code.
-
 Activate the module in Shopadmin under "Extensions -> Modules".
 
 ## How to use
 
-...
+Call up the pages in the backend of the shop under "Service -> Email checking".
 
 ## Changelog
 
@@ -57,7 +42,7 @@ If you have a suggestion that would make this better, please fork the repo and c
 - Open a Pull Request
 
 ## License
-(status: 2022-07-30)
+(status: 2023-12-13)
 
 Distributed under the GPLv3 license.
 
@@ -67,8 +52,4 @@ 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.
+For full copyright and licensing information, please see the [LICENSE](LICENSE.md) file distributed with this source code.
-
-## Further licences and terms of use
-
-...

README.md

@@ -1,9 +1,7 @@
 [![deutsche Version](https://logos.oxidmodule.com/de2_xs.svg)](README.md)
 [![english version](https://logos.oxidmodule.com/en2_xs.svg)](README.en.md)
 
-# D³ Modulname für OXID eShop
+# D³ E-Mail Konfigurationsprüfung für OXID eShop
-
-Hier Kurzbeschreibung einfügen
 
 ## Inhaltsverzeichnis
 
@@ -12,36 +10,23 @@ Hier Kurzbeschreibung einfügen
 - [Changelog](#changelog)
 - [Beitragen](#beitragen)
 - [Lizenz](#lizenz)
-- [weitere Lizenzen und Nutzungsbedingungen](#weitere-lizenzen-und-nutzungsbedingungen)
 
 ## Installation
 
 Dieses Paket erfordert einen mit Composer installierten OXID eShop in einer in der [composer.json](composer.json) definierten Version.
 
-Bitte tragen Sie den folgenden Abschnitt in die `composer.json` Ihres Projektes ein:
-
-```
-  "extra": {
-    optionale Anweisungen von 3rd-Party-Packages (z.B. Patch- oder Symlink-Anweisungen)
-  }
-```
-
 Öffnen Sie eine Kommandozeile und navigieren Sie zum Stammverzeichnis des Shops (Elternverzeichnis von source und vendor). Führen Sie die folgenden Befehle aus. Passen Sie die Pfadangaben an Ihre Installationsumgebung an.
 
 
 ```bash
-composer require d3/modulename:^2.0
+composer require d3/mailconfigchecker:^1.0
-
-./vendor/bin/oe-eshop-db_migrate migrations:migrate modulemetadataid
 ```
 
-Sofern nötig, bestätigen Sie bitte, dass Sie `package-name` erlauben, Code auszuführen.
-
 Aktivieren Sie das Modul im Shopadmin unter "Erweiterungen -> Module".
 
 ## Verwendung
 
-...
+Rufen Sie die Seiten im Backend des Shops unter "Service -> E-Mail Prüfung" auf.
 
 ## Changelog
 
@@ -58,7 +43,7 @@ Wenn Sie eine Verbesserungsvorschlag haben, legen Sie einen Fork des Repositorie
 - Öffnen Sie einen Pull Request
 
 ## Lizenz
-(Stand: 06.05.2021)
+(Stand: 14.12.2023)
 
 Vertrieben unter der GPLv3 Lizenz.
 
@@ -69,7 +54,3 @@ 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.
-
-## weitere Lizenzen und Nutzungsbedingungen
-
-...