chore: Updates docs

MislavMandaric · May 15, 2022 · b348396 · b348396
1 parent 1c6cb56
commit b348396
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 17 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -13,11 +13,12 @@ Github is used to host code, to track issues and feature requests, as well as ac
 
 Pull requests are the best way to propose changes to the codebase.
 
+1. Start by opening a new issue (if your PR doesn't reference an already existing one), where proposed changes can be discussed
 1. Fork the repo and create your branch from `master`.
-2. If you've changed something, update the documentation.
-3. Make sure your code lints (using black).
-4. Test you contribution.
-5. Issue that pull request!
+1. If you've changed something, update the documentation.
+1. Make sure your code lints (using black).
+1. Test you contribution.
+1. Issue that pull request!
 
 ## Any contributions you make will be under the MIT Software License
 
@@ -42,6 +43,11 @@ Report a bug by [opening a new issue](../../issues/new/choose); it's that easy!
 
 People _love_ thorough bug reports. I'm not even kidding.
 
+## Request new features using Github's [issues](../../issues)
+
+Github issues are also used to track feature requests.
+Same as with bug repors, request new features by [opening a new issue](../../issues/new/choose).
+
 ## Use a Consistent Coding Style
 
 Use [black](https://github.com/ambv/black) and [prettier](https://prettier.io/)
@@ -50,6 +56,12 @@ to make sure the code follows the style.
 Or use the `pre-commit` settings implemented in this repository
 (see deicated section below).
 
+## Use Semantic Release commit and branch naming conventions
+
+This component uses [Semantic Release](https://github.com/semantic-release/semantic-release) to automate releases.
+
+Read and follow all the naming conventions outlined in their docs. Check out already existing commits and pull requests for guidance.
+
 ## Test your code modification
 
 This custom component is based on [integration_blueprint template](https://github.com/custom-components/integration_blueprint).

diff --git a/README.md b/README.md
@@ -14,11 +14,12 @@
 
 **This component will set up the following platforms.**
 
-| Platform        | Description                                |
-| --------------- | ------------------------------------------ |
-| `climate`       | Management of Vaillant thermostat.         |
-| `switch`        | Hot water boost switch of the thermostat.  |
-| `sensor`        | Battery sensor for the thermostat.         |
+| Platform        | Description                                      |
+| --------------- | ------------------------------------------------ |
+| `climate`       | Management of Vaillant thermostat.               |
+| `select`        | Selector showing currently selected schedule.    |
+| `sensor`        | Battery sensor for the thermostat.               |
+| `switch`        | Hot water boost and on/off switch for schedules. |
 
 ## Installation
 

diff --git a/hacs.json b/hacs.json
@@ -1,12 +1,10 @@
 {
     "name": "Vaillant vSMART",
-    "hacs": "1.6.0",
     "domains": [
         "climate",
         "select",
         "sensor",
         "switch"
     ],
-    "iot_class": "Cloud Polling",
-    "homeassistant": "2021.6"
+    "homeassistant": "2022.1"
 }
diff --git a/info.md b/info.md
@@ -9,11 +9,12 @@
 
 **This component will set up the following platforms.**
 
-| Platform        | Description                                |
-| --------------- | ------------------------------------------ |
-| `climate`       | Management of Vaillant thermostat.         |
-| `switch`        | Hot water boost switch of the thermostat.  |
-| `sensor`        | Battery sensor for the thermostat.         |
+| Platform        | Description                                      |
+| --------------- | ------------------------------------------------ |
+| `climate`       | Management of Vaillant thermostat.               |
+| `select`        | Selector showing currently selected schedule.    |
+| `sensor`        | Battery sensor for the thermostat.               |
+| `switch`        | Hot water boost and on/off switch for schedules. |
 
 {% if not installed %}
 
@@ -27,6 +28,24 @@
 
 ## Configuration is done in the UI
 
+Check out the [community page](https://community.home-assistant.io/t/added-support-for-vaillant-thermostat-how-to-integrate-in-official-release/31858). You can find out how to extract client ID and client secret there.
+
+For Vaillant Vsmart
+- Client ID : na_client_android_vaillant
+- Client secret : XXXXXXXXXXXXXXXXXXXXXXX (see above)
+- Username : MY_VAILLANT_APP_USERNAME
+- Password : MY_VAILLANT_APP_PWD
+- User prefix : vaillant
+- App version : 1.0.4.0
+
+For MiGo
+- Client ID : na_client_android_sdbg
+- Client secret : XXXXXXXXXXXXXXXXXXXXXXX (see above)
+- Username : MY_MIGO_APP_USERNAME
+- Password : MY_MIGO_APP_PWD
+- User prefix : sdbg
+- App version : 1.3.0.4
+
 <!---->
 
 ## Credits