Merge pull request #42 from CaritasDeutschland/feature-add-service-de…

…scription docs: added service description
Onlineberatung · Jun 25, 2021 · 1b3b6dc · 1b3b6dc
2 parents b5e0ae0 + ac26136
commit 1b3b6dc
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/...mentation/MailService-Architektur.graphml → ...mentation/MailService-Architektur.graphml b/...mentation/MailService-Architektur.graphml → ...mentation/MailService-Architektur.graphml
diff --git a/Dokumentation/MailService-Architektur.png → documentation/MailService-Architektur.png b/Dokumentation/MailService-Architektur.png → documentation/MailService-Architektur.png
diff --git a/readme.md b/readme.md
@@ -1,8 +1,12 @@
 # Caritas Online-Beratung MailService
-This is the repository containing all logic for the Caritas Online-Beratung MailService.
+
+The MailService provides REST API calls which trigger e-mail dispatching for users and also error notifications for system administrators.
+The service must only be reachable from within the Docker network and therefore can only be triggered by other services and not externally (by the client).
+It comes up with predefined templates but also a free text template which supports HTML elements.
 
 ## Help and Documentation
 In the project [documentation](https://caritasdeutschland.github.io/documentation/docs/setup/setup-backend) you'll find information for setting up and running the project.
+You can find some detailled information of the service architecture and its processes in the repository [documentation](https://github.com/CaritasDeutschland/caritas-onlineBeratung-mailService/tree/master/documentation).
 
 ## License
 The project is licensed under the AGPLv3 which you'll find [here](https://github.com/CaritasDeutschland/caritas-onlineBeratung-mailService/blob/master/LICENSE).