From 7f08f4adcc27bb4128eeac95ccf9d64bde7f2180 Mon Sep 17 00:00:00 2001
From: Dryusdan <contact@dryusdan.fr>
Date: Wed, 9 Dec 2020 20:03:13 +0100
Subject: [PATCH] Improve README

---
 README.md | 29 ++++++++++++++++++++++++++---
 1 file changed, 26 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 4f54082..f78731a 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,28 @@
 # OVH-server-tracker
 
-An OVH server tracker for Kimsufi, maybe So You Start.
-
-Many communication channel 
\ No newline at end of file
+An OVH server tracker for Kimsufi, maybe So You Start.
+
+## Purpose
+
+The objective is to **send notifications** when the Kimsufi server you want is available in the zone(s) desired.
+There is many type of notification listed here : https://github.com/caronc/apprise
+Actualy only email, xmpp are supported here. Easy to integrate other (see `src/notifications.py`)
+Discord and Matrix are planned.
+
+## Documentation
+
+### References and zones
+
+In `doc/`, you can find [the list of references](https://git.drycat.fr/Dryusdan/OVH-server-tracker/src/branch/stable/config/refToName.yml) 
+Zone are fra, gra, rbx, sbg for Kimsufi
+
+## Installation
+
++ `git clone https://git.drycat.fr/Dryusdan/OVH-server-tracker.git`
++ `cd kimsufi`
++ Create virtual environment: `python3 -m venv .`
++ Source it: `source bin/activate`
++ Install dependencies: `pip install -r requirements.txt`
++ `cp config/kimsufi.sample.yml config/kimsufi.yml`
++ Edit *config/kimsufi.yml*
++ `python3 servertracker.py