From ac9e4d211cd5fbbe7d95d5abbde692da725d2ca8 Mon Sep 17 00:00:00 2001 From: Andre Basche Date: Sun, 5 Mar 2023 01:22:05 +0100 Subject: [PATCH] Update README, add license --- LICENSE | 21 +++++++++++++++++++++ README.md | 24 ++++++++++++++++++++++++ 2 files changed, 45 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..318db18 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Andre Basche + +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. diff --git a/README.md b/README.md index 6e8b26b..d5c9b80 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # hOn Home Assistant component supporting hOn cloud. + +## Installation +1. Installing via HACS +2. Go to HACS->Integrations +3. Add this repo into your HACS custom repositories +4. Search for Haier hOn and Download it +5. Restart your HomeAssistant +6. Go to Settings->Devices & Services +7. Shift reload your browser +8. Click Add Integration +9. Search for Haier hOn +10. Type your username used in the hOn App and hit submit + +## Supported Appliances +- Washing Machine + +## Tested Devices +- Haier WD90 + +## About this Repo +The existing integrations missed some features from the app I liked to have in HomeAssistant. +I tried to create a pull request, but in the structures of these existing repos, I find it hard to fit in my needs, so I basically rewrote everything. +I moved the api related stuff into the package [pyhOn](https://github.com/Andre0512/pyhOn). +