From c8d404ba16f4c2c09d794759ba3ba40e1e0e0052 Mon Sep 17 00:00:00 2001
From: delvh <dev.lh@web.de>
Date: Thu, 2 Jan 2020 15:12:25 +0100
Subject: [PATCH] Update README.md

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 96825b7..491248c 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,27 @@
-# envoy-common
\ No newline at end of file
+# Envoy Common
+
+<a href="https://github.com/informatik-ag-ngl/envoy-client"><img src="https://raw.githubusercontent.com/informatik-ag-ngl/envoy-client/develop/src/main/resources/envoy_logo.png" align="left" width="200" height="200"></a>
+
+**Envoy Common** is one of two repositories needed to use the messenger Envoy.<br>
+The other one is <a href="https://github.com/informatik-ag-ngl/envoy-client">**Envoy Client**</a>.<br>
+In the future, Envoy Common might be discarded, but for now, both Repositories are required in order to use Envoy to send messages to other people.<br>
+<br><br>
+
+## Features
+
+Envoy Common consists of all classes that are used both on client side and the server side, thus making them "common".
+Currently used features are:
+
+* Messages
+* Users
+  * LoginCredentials
+* Logging
+* Event System
+* EnvoyException
+  
+## Resources
+
+* [API Reference (later on)](https://github.com/informatik-ag-ngl/envoy-common/wiki)
+* [Release Notes](https://github.com/informatik-ag-ngl/envoy-common/releases)
+* [Gallery (later on)](https://github.com/informatik-ag-ngl/envoy-common/wiki/Gallery)
+* [Wiki](https://github.com/informatik-ag-ngl/envoy-common/wiki)