Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
filipsPL committed May 22, 2021
1 parent c73df5a commit be20a55
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
mqtt_monitor
======================


<!-- TOC START min:1 max:6 link:true asterisk:false update:true -->
- [About mqtt_monitor](#about-mqtt_monitor)
- [About](#about)
- [Installation](#installation)
- [With conda](#with-conda)
- [With pip](#with-pip)
- [Conda python environment](#conda-python-environment)
- [Set up with pip](#set-up-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
# About

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.
This is a simple console 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 eye-candies and colors to the presented data.

![screenshot](obrazki/README-88cf8fcc.png)

Expand All @@ -21,22 +25,22 @@ It was tested (under GitHub Actions CI/CD) and works under:
- 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)
CI Status: [![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

`git clone git@github.com:filipsPL/mqtt-monitor.git`

## With conda
### Conda python environment

```
conda env create -f conda.yml
conda activate mqttmonitor
```

## With pip
### Set up with pip

`pip install -r requirements.txt`

Expand Down

0 comments on commit be20a55

Please sign in to comment.