Merge branch 'dev' into 'master'

Add some documentation

See merge request !2

Demo/MailAdm-Doku.Tests.ps1

-# initializing
+# These are the Pester Tests in order to demonstrate how the API works
+
+# initializing
 # connection settings
 $user = "<MailAdm Serviceaccount>"
 $password = "<password>"

Demo/MailAdm-Doku.ps1

-
-
-

Demo/connect.ps1

+# functioncall in order to get an active connection to the MailAdm API
+
 function new-mailadmconnection {
     [CmdletBinding()]
     param (

Demo/distributionlist.ps1

+# functioncalls in order to administer dristributionlists 
+
 function create-distributionlist {
     [CmdletBinding()]
     param ($WebserviceConnection, $displayname, $mailaddress)

Demo/listquota.ps1

+#functioncall in order to administer quotapools
+
 function get-quotapool {
     [CmdletBinding()]
     param (

Demo/mailaccounts.ps1

+#functioncalls in oder to administer mailaddresses
+
 function get-mailaccounts {
     [CmdletBinding()]
     param ($webserviceconnection)

readme.md

-# Project Title
+# MailAdm API
 
-MailAdm API
+## Hintergrund
 
-## Getting Started
+Das IT Center der RWTH Aachen stellt den zentralen Mailserver bereit. Die Verwaltung der Mailadressen wird durch registrierte Ansprechpartner für die jeweiligen Einrichtungen (Maildomänen) über eine Web Application (MailAdm) vorgenommen. Um die Prozesse zur Pflege von Mailadressen in die internen Abläufe automatisch integrieren zu können, wird neben dem MailAdm auch eine entsprechende, auf SOAP basierende, API angeboten, so dass die Pflege der Mailadressen in die vorhandenen lokalen Prozesse der jeweiligen Einrichtung integriert werden kann.
 
-Das IT Center der RWTH Aachen stellt den zentralen Mailserver bereit. Die Verwaltung der Mailadressen wird durch registrierte Ansprechpartner für die jeweiligen Einrichtungen (Maildomänen) über eine Web Application (MailAdm) vorgenommen. Um die Prozesse zur Pflege von Mailadressen in die internen Abläufe automatisch integrieren zu können, wird neben dem MailAdm auch eine entsprechende API angeboten, so dass die Pflege der Mailadressen in die vorhandenen lokalen Prozesse der jeweiligen Einrichtung integriert werden kann.
+### Voraussetzungen
 
-### Prerequisites
+Zur Nutzung der MailAdm API benötigen Sie einen Serviceaccount. Diesen können Sie anfordern, indem sie eine Mail an servicedesk@itc.rwth-aachen.de schicken. Derzeit ist unsere Schnittstelle mit der Windows Powershell 5.1 getestet.
 
-Zur Nutzung der MailAdm API benötigen Sie einen Serviceaccount. Diesen können Sie anfordern, indem sie eine Mail an servicedesk@itc.rwth-aachen.de schicken.
+## Projektinhalt
 
-## Running the Tests
+Das Projekt besteht aus dem Unerverzeichnis Demo, dass beispielhaft den in der API beritgestellten Funktionen zeigt. Hierbei beinhalten die einzelnen Datien folgende Themenblöcke:
+1. connect.ps1
+- Verbindungsaufbau zur API
+listquota.ps1
+- Funktionsaufrufe zur Verwaltung des Quotapool
+mailaccounts.ps1
+- Funktionsaufrufe zur verwaltung von Mailadressen
+distributionlist.ps1
+- Funktionsaufrufe zur Verwaltung von Verteilerlisten
+
+## Ausführung
 
 Im Verzeichnis Demo finden Sie entsprechende Unittests, um die Schnittstelle mit Ihrem Serviceaccount zu testen. Bitte passen Sie hierzu in der Datei MailAdm-Doku.Tests.ps1 den Bereich "connection settings" an.
+Um die Tests zu starten, wechseln Sie mit in der Windows Powershell ins "Demo" Verzeichnis und starten Sie das Cmdlet invoke-pester
 
-## Authors
+## Autoren
 
 * **Wilfred Gasper**
 * **Michael Wirtz**