Merge branch 'release/v0.0.1rc'

README.md

@@ -0,0 +1,27 @@
+JitsiBadge 
+==========
+
+Simple Logfile parser and local status server for public jitsi meet instances 
+
+## Features
+ - returns conference state as text or svg badge
+ 
+ 
+## Requirements
+
+ - Python 3.5 or newer
+ - Sh Module https://pypi.org/project/sh/
+ - pyBadges Module https://pypi.org/project/pybadges/
+ 
+## Optional (eg for production)
+
+ - Reverse HTTP Proxy (Nginx, Apache ...)
+ - a user to run jitsiBadge on your server
+ 
+## Setup
+
+ - Clone this repo to your jitsi server
+ - optional: python virtual environment (`python -m venv venv`)
+ - make sure python requirements are present: `pip install -r requirements.txt`
+ - run: `python3 jitsi-log.py -l /PATH/2/JICOFO.LOG [ -p PORT]`
+