From 83d3e6c0a442e3aa2b3e3d23a0e9effd564767e2 Mon Sep 17 00:00:00 2001
From: Florian Charlaix <flifloo@gmail.com>
Date: Sun, 30 Jan 2022 19:41:07 +0100
Subject: [PATCH] Update README

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index d773a2f..c45685b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,23 @@
 # Java TP
+Florian CHARLAIX - Pierre WATTEAU | DevOps 1 
 
+## Server
+To start the server, simply execute MainServer with the port to listen too as the first argument.
+
+The server need a MariaDB server, on the first start the server crate a `server.properties` file with database credentials:
+```properties
+password=test
+address=127.0.0.1
+port=2222
+pseudo=test
+```
+
+## Client
+The client can be executed as a command line interface (MainClient) or a graphical one (MainGUI).
+
+On the command line interface you have to pass ome arguments:
+```
+<Server address> <Server port> <Username> <Password>
+```
+
+The client configuration is stored in `connection.properties`.