Update readme

Readme.md

@@ -1,30 +1,43 @@
-# MQTT-Explorer
+# [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://travis-ci.org/thomasnordquist/MQTT-Explorer.svg)](https://travis-ci.org/thomasnordquist/MQTT-Explorer)
 
 ### Version 0.1.3
-See the whole picture of your message queue.
+
+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?
+
+MQTT-Explorer strives to be THE swiss-army-knife tool.
 The perfect tool to integrate new services, IoT devices in your network.
-This application subscribes to all topics on your MQTT-Server and displays your message queue hierarchy, allowing you to drill-down to the topics that are of interest.
+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.1.3/MQTT-Explorer-0.1.3.exe), [installer](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-Setup-0.1.3.exe)), Linux ([AppImage](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-0.1.3-x86_64.AppImage)) and Mac ([dmg](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-0.1.3.dmg)).
+
+## Demo
+![screencast](https://user-images.githubusercontent.com/7721625/51978075-5bc0eb00-2489-11e9-953a-0965b154557b.gif)
 
 ## Download
-The app is prebuilt for Windows ([portable](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-0.1.3.exe), [installer](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-Setup-0.1.3.exe)), Linux ([AppImage](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-0.1.3-x86_64.AppImage)) and Mac ([dmg](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-0.1.3.dmg)).
 
 | 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.1.3/MQTT-Explorer-0.1.3.exe), [installer](https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.1.3/MQTT-Explorer-Setup-0.1.3.exe) |
 | ![linux](https://user-images.githubusercontent.com/7721625/51445392-947ff800-1d04-11e9-8c7f-a30efb755651.png) | Linux | [AppImage](https:&#x2F;&#x2F;github.com&#x2F;thomasnordquist&#x2F;MQTT-Explorer&#x2F;releases&#x2F;download&#x2F;v0.1.3&#x2F;MQTT-Explorer-0.1.3-x86_64.AppImage)<br>*Run AppImage:<br>Make it executable and double-click it.* | 
 | ![mac](https://user-images.githubusercontent.com/7721625/51445390-921d9e00-1d04-11e9-8339-351469ef20ae.png) | Mac | [dmg](https:&#x2F;&#x2F;github.com&#x2F;thomasnordquist&#x2F;MQTT-Explorer&#x2F;releases&#x2F;download&#x2F;v0.1.3&#x2F;MQTT-Explorer-0.1.3.dmg) | 
 
-More architectures and package types: [Downloads](https://github.com/thomasnordquist/MQTT-Explorer/releases)
+[More Downloads](https://github.com/thomasnordquist/MQTT-Explorer/releases)
-
-## What does MQTT-Explorer do?
-![screencast](https://user-images.githubusercontent.com/7721625/51978075-5bc0eb00-2489-11e9-953a-0965b154557b.gif)
 
 ## Screenshots
 ![screen1](https://user-images.githubusercontent.com/7721625/51770198-6c6a0d80-20e5-11e9-94d5-a0174634253c.png)
 
+## 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.
+
+Future releases will allow for a more granular selection of subscribed topics to handle
+
 ## Develop
 PRs and issues are welcome
 
@@ -34,6 +47,12 @@ Start with `npm run start`
 
 The `app` directory contains all the rendering logic, the `backend` directory currently contains the models, tests, connection management.
 
+## Automated Tests
+To achieve a reliable product automated tests run regulary on travis.
+- Data model
+- MQTT integration
+- UI-Tests (The demo is a recorded ui test)
+
 ## Telemetry
 The App sends telemetry and error reports, this enables me to quickly react on bugs/errors I produced.
 This is a difficutlt task since this App runs on three different operating systems and architectures.

Readme.tpl.md

@@ -1,30 +1,43 @@
-# MQTT-Explorer
+# [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://travis-ci.org/thomasnordquist/MQTT-Explorer.svg)](https://travis-ci.org/thomasnordquist/MQTT-Explorer)
 
 ### Version {{ version }}
-See the whole picture of your message queue.
+
+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?
+
+MQTT-Explorer strives to be THE swiss-army-knife tool.
 The perfect tool to integrate new services, IoT devices in your network.
-This application subscribes to all topics on your MQTT-Server and displays your message queue hierarchy, allowing you to drill-down to the topics that are of interest.
+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}}).
+
+## Demo
+![screencast](https://user-images.githubusercontent.com/7721625/51978075-5bc0eb00-2489-11e9-953a-0965b154557b.gif)
 
 ## Download
-The app is prebuilt for Windows ({{windowsTargets}}), Linux ({{linuxTargets}}) and Mac ({{macTargets}}).
 
 | 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}}<br>*Run AppImage:<br>Make it executable and double-click it.* | 
 | ![mac](https://user-images.githubusercontent.com/7721625/51445390-921d9e00-1d04-11e9-8339-351469ef20ae.png) | Mac | {{macTargets}} | 
 
-More architectures and package types: [Downloads](https://github.com/thomasnordquist/MQTT-Explorer/releases)
+[More Downloads](https://github.com/thomasnordquist/MQTT-Explorer/releases)
-
-## What does MQTT-Explorer do?
-![screencast](https://user-images.githubusercontent.com/7721625/51978075-5bc0eb00-2489-11e9-953a-0965b154557b.gif)
 
 ## Screenshots
 ![screen1](https://user-images.githubusercontent.com/7721625/51770198-6c6a0d80-20e5-11e9-94d5-a0174634253c.png)
 
+## 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.
+
+Future releases will allow for a more granular selection of subscribed topics to handle
+
 ## Develop
 PRs and issues are welcome
 
@@ -34,6 +47,12 @@ Start with `npm run start`
 
 The `app` directory contains all the rendering logic, the `backend` directory currently contains the models, tests, connection management.
 
+## Automated Tests
+To achieve a reliable product automated tests run regulary on travis.
+- Data model
+- MQTT integration
+- UI-Tests (The demo is a recorded ui test)
+
 ## Telemetry
 The App sends telemetry and error reports, this enables me to quickly react on bugs/errors I produced.
 This is a difficutlt task since this App runs on three different operating systems and architectures.

_config.yml

@@ -1,2 +1,11 @@
 theme: jekyll-theme-architect
+title: MQTT Explorer
+description: Tool to visualize your MQTT topics, a MQTT swiss-army knife
+author:
+  name: Thomas Nordquist
+  picture: https://avatars1.githubusercontent.com/u/7721625?s=460&v=4 
+github_username: thomasnordquist
+logo: https://user-images.githubusercontent.com/7721625/52227945-5280b580-28b1-11e9-804c-75a842537393.png
+plugins:
+  - jekyll-seo-tag
 google_analytics: UA-133696837-1

_layouts/_default.html

@@ -0,0 +1,6 @@
+<html>
+  <head>
+    {% include head.html %}
+    {% seo %}
+  </head>
+</html>