README update and minor changes

Author: filipsPL

README.md

@@ -1,8 +1,29 @@
-# mqtt-monitor
+<!-- TOC START min:1 max:6 link:true asterisk:false update:true -->
+- [About mqtt_monitor](#about-mqtt_monitor)
+- [Installation](#installation)
+  - [With conda](#with-conda)
+  - [With pip](#with-pip)
+- [Usage](#usage)
+  - [Test server](#test-server)
+  - [Set up your own config](#set-up-your-own-config)
+- [Screencast](#screencast)
+<!-- TOC END -->
+
+
+# About mqtt_monitor
 
 This is a simple mqtt topic monitor written in python 3. It allows you to subscribe and listen to a number of mqtt topics and display it in a form of table. Optionally it adds some colors to the presented data.
 
-![](obrazki/README-d0cef477.png)
+![screenshot](obrazki/README-88cf8fcc.png)
+
+It was tested (under GitHub Actions CI/CD) and works under:
+- OS: Ubuntu, MacOS, and Windows
+- Python versions: 3.5, 3.8, and 3.9
+
+
+[![Python application](https://github.com/filipsPL/mqtt-monitor/actions/workflows/python-app.yml/badge.svg)](https://github.com/filipsPL/mqtt-monitor/actions/workflows/python-app.yml)
+
+
 
 # Installation
 
@@ -17,10 +38,26 @@ conda activate mqttmonitor
 
 ## With pip
 
-`pip install paho-mqtt pandas tabulate`
-
+`pip install -r requirements.txt`
 
 # Usage
 
-- create a conf file from template `cp mqtt_conf.py.sample mqtt_conf.py`
-- edit
+## Test server
+
+Connect to the test server and wait for messages:
+
+`./mqtt_monitor.py --conf mqtt_monitor.conf.sample`
+
+## Set up your own config
+
+- create a conf file from template `cp mqtt_monitor.conf.sample mqtt_monitor.conf`
+- edit `mqtt_monitor.conf`
+- run `./mqtt_monitor.py --conf mqtt_monitor.conf`
+- enjoy
+
+
+# Screencast
+
+See the monitor in action:
+
+[![asciicast](https://asciinema.org/a/mzgmn185M2SLa2caatQ8CRNrP.svg)](https://asciinema.org/a/mzgmn185M2SLa2caatQ8CRNrP)

mqtt_monitor.conf.sample

@@ -52,3 +52,4 @@ sensor2 = garden
 'p'= "☁ " + colors.fg.cyan
 'out'= colors.fg.red
 'in'= colors.fg.yellow
+'rssi'= '📶 ' + colors.fg.lightgrey