Added README.md

README.md

@@ -0,0 +1,49 @@
+# Envoy
+---
+<a href="https://github.com/informatik-ag-ngl/envoy"><img src="https://raw.githubusercontent.com/informatik-ag-ngl/envoy/develop/client/src/main/resources/icons/envoy_logo.png" align="right" width="150" height="150"></a>
+<a href="https://github.com/informatik-ag-ngl/envoy/milestone/1"><img alt="GitHub milestone" src="https://img.shields.io/github/milestones/progress-percent/informatik-ag-ngl/envoy/1"></a>
+<a href="https://github.com/informatik-ag-ngl/envoy/pulls"><img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr-raw/informatik-ag-ngl/envoy?style=flat"></a>
+<a href="https://github.com/informatik-ag-ngl/envoy/issues"><img alt="GitHub issues" src="https://img.shields.io/github/issues/informatik-ag-ngl/envoy?style=flat"></a>
+<a href="https://github.com/informatik-ag-ngl/envoy/actions"><img src="https://github.com/informatik-ag-ngl/envoy/workflows/Java%20CI/badge.svg"></a>
+
+**Envoy** is a messenger written in Java.<br>
+It is split into three separate components: Envoy Client, Envoy Common and Envoy Server.
+<br><br><br><br><br>
+---
+### Envoy Client:
+This is the only part users are interested in. It contains everything to make this messenger work: the UI.
+### Envoy Server:
+Envoy offers the option to download and host your own server over which Envoy can run.<br>
+This part will be especially appealing to institutions/organizations who want to self-host Envoy.
+### Envoy Common:
+This part contains elements that both the client and the server need. It will be automatically part of either one (Thanks, Maven!).
+
+## Features
+
+Envoy features a lot of things and many more are yet to come.
+Currently existing features are:
+
+#### 'Client' contains:
+
+* typical Messenger features (sending and receiving of messages, groups, sending images and voice messages)
+* typical Messenger feeling (displaying unread messages)
+* Appealing user interface (UI)
+
+* Programming
+  * API to change default configuration
+  * Advanced logging possibilities
+  * Tons of Events to interact with
+  * Detailed Javadoc to improve readability of code
+
+#### 'Common' contains:
+* the event system
+* the logger
+* Envoy-specific Exceptions
+* some util classes
+* the most basic datatypes
+
+#### 'Server' contains:
+* the database implementation of the data classes
+* the connectivity classes
+* processors to handle incoming events
+* Utility classes to check client version compatability and Password validity