From d9fcf59ca4f55ac1e3dcbed4558d421a8adace27 Mon Sep 17 00:00:00 2001 From: Thomas Nordquist Date: Mon, 18 Mar 2019 22:02:09 +0100 Subject: [PATCH] Update readme --- Readme.md | 28 +++++++++++++++------------- Readme.tpl.md | 28 +++++++++++++++------------- res/star.svg | 6 ++++++ 3 files changed, 36 insertions(+), 26 deletions(-) create mode 100644 res/star.svg diff --git a/Readme.md b/Readme.md index 6b7c7e9..898af9c 100644 --- a/Readme.md +++ b/Readme.md @@ -1,10 +1,15 @@ # [MQTT Explorer](https://thomasnordquist.github.io/MQTT-Explorer/) + [![Downloads](https://img.shields.io/github/release/thomasnordquist/mqtt-explorer.svg)](https://travis-ci.org/thomasnordquist/MQTT-Explorer/releases) [![Downloads](https://img.shields.io/github/downloads/thomasnordquist/mqtt-explorer/total.svg)](https://travis-ci.org/thomasnordquist/MQTT-Explorer/releases) [![Build_Status](https://travis-ci.org/thomasnordquist/MQTT-Explorer.svg?branch=master)](https://travis-ci.org/thomasnordquist/MQTT-Explorer) [![Build status](https://ci.appveyor.com/api/projects/status/c35tkm29rm4m5364/branch/master?svg=true)](https://ci.appveyor.com/project/thomasnordquist/mqtt-explorer/branch/master) -### Version 0.2.3 +| | | | +|:---:|:---:|:---:| +| [![screen1_small](https://user-images.githubusercontent.com/7721625/53954800-84b34c00-40d7-11e9-842d-bf655c569600.jpg)](https://user-images.githubusercontent.com/7721625/53954364-52551f00-40d6-11e9-93cf-d5a9601897ea.png) | [![screen2_small](https://user-images.githubusercontent.com/7721625/53954801-84b34c00-40d7-11e9-913a-42572e675620.jpg)](https://user-images.githubusercontent.com/7721625/53954365-52551f00-40d6-11e9-823f-afd66f19ed01.png) | [![screen3_small](https://user-images.githubusercontent.com/7721625/53954802-854be280-40d7-11e9-973c-08f23c8dbf89.jpg)](https://user-images.githubusercontent.com/7721625/53954366-52551f00-40d6-11e9-9738-74db830d03ac.png) | + +## Version 0.2.3 A MQTT Tool to get a quick overview of your MQTT topics and integrate new devices/services more efficiently. @@ -22,23 +27,20 @@ The hierarchical view allows for a quick understanding what is going on on your ## Download +Developing this tool takes a lot of effort, sweat and time, please consider rating the App on the Windows or Mac app store . +If you feel like a feature is missing or you found a bug, please leave me a [comment / issue](https://github.com/thomasnordquist/MQTT-Explorer/issues) and I'll see what I can do. + | Platform | | Downloads | |:----------:|:-------------:|:------:| -| ![windows](https://user-images.githubusercontent.com/7721625/51445407-b4172080-1d04-11e9-8c70-d8413d1d6d8b.png) | Windows |
[portable](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.3/MQTT-Explorer-0.2.3.exe), [installer](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.3/MQTT-Explorer-Setup-0.2.3.exe) | -| ![ubuntu](https://user-images.githubusercontent.com/7721625/51445401-a5306e00-1d04-11e9-9b9b-20e196b82142.png) | Ubuntu |
[Ubuntu Store](snap://mqtt-explorer) | -| ![mac](https://user-images.githubusercontent.com/7721625/51445390-921d9e00-1d04-11e9-8339-351469ef20ae.png) | Mac |
[dmg](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.3/MQTT-Explorer-0.2.3.dmg) | -| ![linux](https://user-images.githubusercontent.com/7721625/51445392-947ff800-1d04-11e9-8c7f-a30efb755651.png) | Linux | [AppImage](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.3/MQTT-Explorer-0.2.3-x86_64.AppImage)
*Run AppImage:
Make it executable and double-click it.* | +| ![windows](https://user-images.githubusercontent.com/7721625/51445407-b4172080-1d04-11e9-8c70-d8413d1d6d8b.png) | **Windows** |
**[portable](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.3/MQTT-Explorer-0.2.3.exe), [installer](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.3/MQTT-Explorer-Setup-0.2.3.exe)** | +| ![mac](https://user-images.githubusercontent.com/7721625/51445390-921d9e00-1d04-11e9-8339-351469ef20ae.png) | **Mac** |
**[dmg](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.3/MQTT-Explorer-0.2.3.dmg)** | +| ![ubuntu](https://user-images.githubusercontent.com/7721625/51445401-a5306e00-1d04-11e9-9b9b-20e196b82142.png) | **Ubuntu**
*also for debian, mint, neon, fedora, etc...* |
`snap install mqtt-explorer`
[Ubuntu Store](snap://mqtt-explorer) | +| ![linux](https://user-images.githubusercontent.com/7721625/51445392-947ff800-1d04-11e9-8c7f-a30efb755651.png) | **Linux**
*almost every linux* | **[AppImage](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.3/MQTT-Explorer-0.2.3-x86_64.AppImage)**
*Run AppImage:
Make it executable and double-click it.* | [More Downloads](https://github.com/thomasnordquist/MQTT-Explorer/releases) -## Screenshots - -| | | | -|:---:|:---:|:---:| -| [![screen1_small](https://user-images.githubusercontent.com/7721625/53954800-84b34c00-40d7-11e9-842d-bf655c569600.jpg)](https://user-images.githubusercontent.com/7721625/53954364-52551f00-40d6-11e9-93cf-d5a9601897ea.png) | [![screen2_small](https://user-images.githubusercontent.com/7721625/53954801-84b34c00-40d7-11e9-913a-42572e675620.jpg)](https://user-images.githubusercontent.com/7721625/53954365-52551f00-40d6-11e9-823f-afd66f19ed01.png) | [![screen3_small](https://user-images.githubusercontent.com/7721625/53954802-854be280-40d7-11e9-973c-08f23c8dbf89.jpg)](https://user-images.githubusercontent.com/7721625/53954366-52551f00-40d6-11e9-9738-74db830d03ac.png) | - - ## Video + ![screencast](https://user-images.githubusercontent.com/7721625/53954172-b7f4db80-40d5-11e9-852c-f8d85e511a00.gif) ## Performance @@ -78,7 +80,7 @@ This greatly helps to improve the software quality and reliability. It basically sends: app version, processor architecture, operating system, used memory, user interactions and error stacks.
-

Example telemetry

+Example telemetry ```javascript diff --git a/Readme.tpl.md b/Readme.tpl.md index 589bab0..cbb863e 100644 --- a/Readme.tpl.md +++ b/Readme.tpl.md @@ -1,10 +1,15 @@ # [MQTT Explorer](https://thomasnordquist.github.io/MQTT-Explorer/) + [![Downloads](https://img.shields.io/github/release/thomasnordquist/mqtt-explorer.svg)](https://travis-ci.org/thomasnordquist/MQTT-Explorer/releases) [![Downloads](https://img.shields.io/github/downloads/thomasnordquist/mqtt-explorer/total.svg)](https://travis-ci.org/thomasnordquist/MQTT-Explorer/releases) [![Build_Status](https://travis-ci.org/thomasnordquist/MQTT-Explorer.svg?branch=master)](https://travis-ci.org/thomasnordquist/MQTT-Explorer) [![Build status](https://ci.appveyor.com/api/projects/status/c35tkm29rm4m5364/branch/master?svg=true)](https://ci.appveyor.com/project/thomasnordquist/mqtt-explorer/branch/master) -### Version {{ version }} +| | | | +|:---:|:---:|:---:| +| [![screen1_small](https://user-images.githubusercontent.com/7721625/53954800-84b34c00-40d7-11e9-842d-bf655c569600.jpg)](https://user-images.githubusercontent.com/7721625/53954364-52551f00-40d6-11e9-93cf-d5a9601897ea.png) | [![screen2_small](https://user-images.githubusercontent.com/7721625/53954801-84b34c00-40d7-11e9-913a-42572e675620.jpg)](https://user-images.githubusercontent.com/7721625/53954365-52551f00-40d6-11e9-823f-afd66f19ed01.png) | [![screen3_small](https://user-images.githubusercontent.com/7721625/53954802-854be280-40d7-11e9-973c-08f23c8dbf89.jpg)](https://user-images.githubusercontent.com/7721625/53954366-52551f00-40d6-11e9-9738-74db830d03ac.png) | + +## Version {{ version }} A MQTT Tool to get a quick overview of your MQTT topics and integrate new devices/services more efficiently. @@ -22,23 +27,20 @@ The hierarchical view allows for a quick understanding what is going on on your ## Download +Developing this tool takes a lot of effort, sweat and time, please consider rating the App on the Windows or Mac app store . +If you feel like a feature is missing or you found a bug, please leave me a [comment / issue](https://github.com/thomasnordquist/MQTT-Explorer/issues) and I'll see what I can do. + | Platform | | Downloads | |:----------:|:-------------:|:------:| -| ![windows](https://user-images.githubusercontent.com/7721625/51445407-b4172080-1d04-11e9-8c70-d8413d1d6d8b.png) | Windows |
{{windowsTargets}} | -| ![ubuntu](https://user-images.githubusercontent.com/7721625/51445401-a5306e00-1d04-11e9-9b9b-20e196b82142.png) | Ubuntu |
[Ubuntu Store](snap://mqtt-explorer) | -| ![mac](https://user-images.githubusercontent.com/7721625/51445390-921d9e00-1d04-11e9-8339-351469ef20ae.png) | Mac |
{{macTargets}} | -| ![linux](https://user-images.githubusercontent.com/7721625/51445392-947ff800-1d04-11e9-8c7f-a30efb755651.png) | Linux | {{linuxTargets}}
*Run AppImage:
Make it executable and double-click it.* | +| ![windows](https://user-images.githubusercontent.com/7721625/51445407-b4172080-1d04-11e9-8c70-d8413d1d6d8b.png) | **Windows** |
**{{windowsTargets}}** | +| ![mac](https://user-images.githubusercontent.com/7721625/51445390-921d9e00-1d04-11e9-8339-351469ef20ae.png) | **Mac** |
**{{macTargets}}** | +| ![ubuntu](https://user-images.githubusercontent.com/7721625/51445401-a5306e00-1d04-11e9-9b9b-20e196b82142.png) | **Ubuntu**
*also for debian, mint, neon, fedora, etc...* |
`snap install mqtt-explorer`
[Ubuntu Store](snap://mqtt-explorer) | +| ![linux](https://user-images.githubusercontent.com/7721625/51445392-947ff800-1d04-11e9-8c7f-a30efb755651.png) | **Linux**
*almost every linux* | **{{linuxTargets}}**
*Run AppImage:
Make it executable and double-click it.* | [More Downloads](https://github.com/thomasnordquist/MQTT-Explorer/releases) -## Screenshots - -| | | | -|:---:|:---:|:---:| -| [![screen1_small](https://user-images.githubusercontent.com/7721625/53954800-84b34c00-40d7-11e9-842d-bf655c569600.jpg)](https://user-images.githubusercontent.com/7721625/53954364-52551f00-40d6-11e9-93cf-d5a9601897ea.png) | [![screen2_small](https://user-images.githubusercontent.com/7721625/53954801-84b34c00-40d7-11e9-913a-42572e675620.jpg)](https://user-images.githubusercontent.com/7721625/53954365-52551f00-40d6-11e9-823f-afd66f19ed01.png) | [![screen3_small](https://user-images.githubusercontent.com/7721625/53954802-854be280-40d7-11e9-973c-08f23c8dbf89.jpg)](https://user-images.githubusercontent.com/7721625/53954366-52551f00-40d6-11e9-9738-74db830d03ac.png) | - - ## Video + ![screencast](https://user-images.githubusercontent.com/7721625/53954172-b7f4db80-40d5-11e9-852c-f8d85e511a00.gif) ## Performance @@ -78,7 +80,7 @@ This greatly helps to improve the software quality and reliability. It basically sends: app version, processor architecture, operating system, used memory, user interactions and error stacks.
-

Example telemetry

+Example telemetry ```javascript diff --git a/res/star.svg b/res/star.svg new file mode 100644 index 0000000..1f2a3c0 --- /dev/null +++ b/res/star.svg @@ -0,0 +1,6 @@ + + +