Browse Source

Added README and LICENSE

Jan Willhaus 8 years ago
parent
commit
356d12f556
2 changed files with 29 additions and 0 deletions
  1. 21 0
      LICENSE
  2. 8 0
      README.md

+ 21 - 0
LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jan Willhaus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

+ 8 - 0
README.md

@@ -0,0 +1,8 @@
+# MQTT Flora daemon
+
+The MQTT Flora daemon is a simple daemon to query arbitrary MiFlora plant sensor devices, and send the data to an MQTT server (in my case an embedded one from [Home Assistant](https://home-assistant.io/). It can be configured to match personal needs using the `config.ini` file, and can be daemonized using standard shell foo.
+
+```bash
+pip install -r requirements.txt
+python mqtt-flora.py &
+```