init

mqtt/README.md

@@ -0,0 +1,44 @@
+# Home Assistant Community Add-on: MQTT Server & Web client
+
+[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
+
+[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
+
+[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
+
+Mosquitto MQTT Server bundled with Hivemq's web client.
+
+## Deprecation warning
+
+**This add-on is in a deprecated state!**
+
+This add-on is now deprecated. We highly recommend on switching to the
+official Home Assistant Mosquitto add-on as an alternative.
+
+This add-on will soon be removed from the add-on store.
+
+## About
+
+This add-on combines the power of [Hivemq][hivemq]'s
+web-based MQTT client, and the powerful [Mosquitto][mosquitto]
+broker (MQTT Server). With this, you can host your own MQTT server,
+and inspect/publish messages using the built-in web client!
+
+[Click here for the full documentation][docs]
+
+![Screenshot][screenshot]
+
+[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
+[buymeacoffee]: https://www.buymeacoffee.com/ludeeus
+[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
+[discord]: https://discord.me/hassioaddons
+[docs]: https://github.com/hassio-addons/addon-mqtt/blob/v1.2.0/README.md
+[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
+[forum]: https://community.home-assistant.io/t/community-hass-io-add-ons-mqtt-server-web-client/70376
+[hivemq]: https://www.hivemq.com/
+[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg
+[mosquitto]: https://mosquitto.org/
+[project-stage-shield]: https://img.shields.io/badge/project%20stage-%20!%20DEPRECATED%20%20%20!-ff0000.svg
+[release-shield]: https://img.shields.io/badge/version-v1.2.0-blue.svg
+[release]: https://github.com/hassio-addons/addon-mqtt/tree/v1.2.0
+[screenshot]: https://github.com/hassio-addons/addon-mqtt/raw/master/images/image.png