From d48afb4d3fbd7cf45e29a87aec46c41fde989332 Mon Sep 17 00:00:00 2001
From: Reiko Kaps <r31k@k4p5.de>
Date: Tue, 23 Jun 2020 19:26:30 +0200
Subject: [PATCH] =?UTF-8?q?Readme=20hinzugef=C3=BCgt?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c06d126
--- /dev/null
+++ b/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]`
+