Improve README
This commit is contained in:
parent
9fcfe06c8f
commit
7f08f4adcc
25
README.md
25
README.md
|
@ -2,4 +2,27 @@
|
|||
|
||||
An OVH server tracker for Kimsufi, maybe So You Start.
|
||||
|
||||
Many communication channel
|
||||
## 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
|
||||
|
|
Loading…
Reference in a new issue