diff --git a/Readme.md b/Readme.md index 7da7780..13ac3db 100644 --- a/Readme.md +++ b/Readme.md @@ -3,40 +3,44 @@ [![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)](https://travis-ci.org/thomasnordquist/MQTT-Explorer) -### Version 0.2.0 +### Version -See the whole picture of your broker. -- What topics are active? -- Which retained topics are abandoned? -- Where is this new device / service I connected to the broker? +A MQTT Tool to get a quick overview of your MQTT topics and integrate new devices/services more efficiently. + +- Visualize topics and topic activity +- Delete retained topics +- Search/filter topics +- Delete topic recursively +- Publish topics +- Plot numeric topics +- Keep a history of each topic MQTT-Explorer strives to be THE swiss-army-knife tool. The perfect tool to integrate new services, IoT devices in your network. The hierarchical view allows for a quick understanding what is going on on your broker. -The app is available for Windows ([portable](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.0/MQTT-Explorer-0.2.0.exe), [installer](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.0/MQTT-Explorer-Setup-0.2.0.exe)), Linux ([AppImage](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.0/MQTT-Explorer-0.2.0-x86_64.AppImage)) and Mac ([dmg](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.0/MQTT-Explorer-0.2.0.dmg)). +## Download + +| 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.0/MQTT-Explorer-0.2.0.exe), [installer](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.0/MQTT-Explorer-Setup-0.2.0.exe) | +| ![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.0/MQTT-Explorer-0.2.0-x86_64.AppImage)
*Run AppImage:
Make it executable and double-click it.* | +| ![ubuntu](https://user-images.githubusercontent.com/7721625/51445401-a5306e00-1d04-11e9-9b9b-20e196b82142.png) | Ubuntu | [![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/mqtt-explorer)
[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.0/MQTT-Explorer-0.2.0.dmg) | + +[More Downloads](https://github.com/thomasnordquist/MQTT-Explorer/releases) ## Screenshots ![screen1](https://user-images.githubusercontent.com/7721625/51770198-6c6a0d80-20e5-11e9-94d5-a0174634253c.png) -## Download - -| 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.0/MQTT-Explorer-0.2.0.exe), [installer](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.2.0/MQTT-Explorer-Setup-0.2.0.exe) | -| ![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.0/MQTT-Explorer-0.2.0-x86_64.AppImage)
*Run AppImage:
Make it executable and double-click it.* | -| ![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.0/MQTT-Explorer-0.2.0.dmg) | - -[More Downloads](https://github.com/thomasnordquist/MQTT-Explorer/releases) - ## Demo ![screencast](https://user-images.githubusercontent.com/7721625/52979302-3f073b80-33d5-11e9-9953-b70ebb349439.gif) ## Performance This App is optimized to handle thousands of topics and at least hundreds of thousands messages per minute. -So don't worry if you got >=10k topics and >=100k messages per minute. +So don't worry if you got >=30k topics and >=100.000 messages per minute. -Future releases will allow for a more granular selection of subscribed topics to handle +One can also subscribe to custom topics insted of the "root wildcard #", therefore limiting the amount of messages. ## Develop PRs and issues are welcome diff --git a/Readme.tpl.md b/Readme.tpl.md index 413a8a9..e485909 100644 --- a/Readme.tpl.md +++ b/Readme.tpl.md @@ -5,38 +5,42 @@ ### Version {{ version }} -See the whole picture of your broker. -- What topics are active? -- Which retained topics are abandoned? -- Where is this new device / service I connected to the broker? +A MQTT Tool to get a quick overview of your MQTT topics and integrate new devices/services more efficiently. + +- Visualize topics and topic activity +- Delete retained topics +- Search/filter topics +- Delete topic recursively +- Publish topics +- Plot numeric topics +- Keep a history of each topic MQTT-Explorer strives to be THE swiss-army-knife tool. The perfect tool to integrate new services, IoT devices in your network. The hierarchical view allows for a quick understanding what is going on on your broker. -The app is available for Windows ({{windowsTargets}}), Linux ({{linuxTargets}}) and Mac ({{macTargets}}). +## Download + +| Platform | | Downloads | +|:----------:|:-------------:|:------:| +| ![windows](https://user-images.githubusercontent.com/7721625/51445407-b4172080-1d04-11e9-8c70-d8413d1d6d8b.png) | Windows | {{windowsTargets}} | +| ![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.* | +| ![ubuntu](https://user-images.githubusercontent.com/7721625/51445401-a5306e00-1d04-11e9-9b9b-20e196b82142.png) | Ubuntu | [![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/mqtt-explorer)
[Ubuntu Store](snap://mqtt-explorer) | +| ![mac](https://user-images.githubusercontent.com/7721625/51445390-921d9e00-1d04-11e9-8339-351469ef20ae.png) | Mac | {{macTargets}} | + +[More Downloads](https://github.com/thomasnordquist/MQTT-Explorer/releases) ## Screenshots ![screen1](https://user-images.githubusercontent.com/7721625/51770198-6c6a0d80-20e5-11e9-94d5-a0174634253c.png) -## Download - -| Platform | | Downloads | -|:----------:|:-------------:|:------:| -| ![windows](https://user-images.githubusercontent.com/7721625/51445407-b4172080-1d04-11e9-8c70-d8413d1d6d8b.png) | Windows | {{windowsTargets}} | -| ![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.* | -| ![mac](https://user-images.githubusercontent.com/7721625/51445390-921d9e00-1d04-11e9-8339-351469ef20ae.png) | Mac | {{macTargets}} | - -[More Downloads](https://github.com/thomasnordquist/MQTT-Explorer/releases) - ## Demo ![screencast](https://user-images.githubusercontent.com/7721625/52979302-3f073b80-33d5-11e9-9953-b70ebb349439.gif) ## Performance This App is optimized to handle thousands of topics and at least hundreds of thousands messages per minute. -So don't worry if you got >=10k topics and >=100k messages per minute. +So don't worry if you got >=30k topics and >=100.000 messages per minute. -Future releases will allow for a more granular selection of subscribed topics to handle +One can also subscribe to custom topics insted of the "root wildcard #", therefore limiting the amount of messages. ## Develop PRs and issues are welcome