From b18898ec776551e4fa8fe72234850b33e4424cb5 Mon Sep 17 00:00:00 2001 From: David Straub Date: Thu, 21 Nov 2019 22:20:52 +0100 Subject: [PATCH] Update Readme --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e078dd6..b51000c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Home Assistant Home Connect -This is work in progress of an implementation of a Home Connect component for Home Assistant. +Integration of home appliances supporting the Home Connect standard into Home Assistant. ## Recent breaking changes @@ -10,20 +10,22 @@ Also, you need to **change the redirect URI** compared to before: replace `.../a ## Usage -- Register an account with the [Home Connect Developer Program](https://developer.home-connect.com) -- Register a new application with the Redirect URI `https://YOUR_HOMEASSISTANT_BASE_URL:PORT/auth/external/callback` (it will not work without https, but your Home Assistant instance does *not* have to be accessible from the internet and a self-signed certificate will do) -- Make sure the `http` component in your `configuration.yaml` has the base url set to `YOUR_HOMEASSISTANT_BASE_URL:PORT` (it will not work otherwise) -- Copy the contents of `custom_components` to the `custom_components` directory of your Home Assistant configuration directory -- Add the following to your `configuration.yaml`: +1. Register an account with the [Home Connect Developer Program](https://developer.home-connect.com) +2. Register a new application with the Redirect URI `https://YOUR_HOMEASSISTANT_BASE_URL:PORT/auth/external/callback` (it will not work without https, but your Home Assistant instance does *not* have to be accessible from the internet and a self-signed certificate will do) +3. Make sure the `http` component in your `configuration.yaml` has the base url set to `YOUR_HOMEASSISTANT_BASE_URL:PORT` (it will not work otherwise) +4. Add the following to your `configuration.yaml`: ```yaml homeconnect: client_id: YOUR_CLIENT_ID client_secret: YOUR_CLIENT_SECRET ``` -- Navigate to the Integrations page and select "Home Connect" +5. Copy the contents of `custom_components` to the `custom_components` directory of your Home Assistant configuration directory +6. Navigate to the Integrations page and select "Home Connect" + +Step 5 can also be replaced by using [HACS](https://hacs.xyz/) and adding this repository as a custom repistory. ## Feedback -This is a development preview (**use at your own risk!**). Please report problems by [opening an issue](https://github.com/DavidMStraub/homeassistant-homeconnect/issues). Feel free to report success in the [Home Assistant forum](https://community.home-assistant.io/t/home-connect-alpha-testers-wanted/82603). +Please report problems by [opening an issue](https://github.com/DavidMStraub/homeassistant-homeconnect/issues). Feel free to report success in the [Home Assistant forum](https://community.home-assistant.io/t/home-connect-alpha-testers-wanted/82603). Pull requests are welcome!