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 + + + +**Envoy Common** is one of two repositories needed to use the messenger Envoy.
+The other one is **Envoy Client**.
+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.
+

+ +## 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)