Update README.md

This commit is contained in:
delvh 2020-01-02 15:12:25 +01:00 committed by GitHub
parent d3d1061a29
commit c8d404ba16

View File

@ -1 +1,27 @@
# envoy-common # 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)