Skip to content

Commit be20a55

Browse files
committed
readme update
1 parent c73df5a commit be20a55

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
1+
mqtt_monitor
2+
======================
3+
4+
15
<!-- TOC START min:1 max:6 link:true asterisk:false update:true -->
2-
- [About mqtt_monitor](#about-mqtt_monitor)
6+
- [About](#about)
37
- [Installation](#installation)
4-
- [With conda](#with-conda)
5-
- [With pip](#with-pip)
8+
- [Conda python environment](#conda-python-environment)
9+
- [Set up with pip](#set-up-with-pip)
610
- [Usage](#usage)
711
- [Test server](#test-server)
812
- [Set up your own config](#set-up-your-own-config)
913
- [Screencast](#screencast)
1014
<!-- TOC END -->
1115

1216

13-
# About mqtt_monitor
17+
# About
1418

15-
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.
19+
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.
1620

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

@@ -21,22 +25,22 @@ It was tested (under GitHub Actions CI/CD) and works under:
2125
- Python versions: 3.5, 3.8, and 3.9
2226

2327

24-
[![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)
28+
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)
2529

2630

2731

2832
# Installation
2933

3034
`git clone [email protected]:filipsPL/mqtt-monitor.git`
3135

32-
## With conda
36+
### Conda python environment
3337

3438
```
3539
conda env create -f conda.yml
3640
conda activate mqttmonitor
3741
```
3842

39-
## With pip
43+
### Set up with pip
4044

4145
`pip install -r requirements.txt`
4246

0 commit comments

Comments
 (0)