Skip to content

Commit 7b6cccb

Browse files
authored
Merge pull request #36 from BDVGitHub/main
docs: Update README
2 parents 35966f5 + e2460cc commit 7b6cccb

1 file changed

Lines changed: 28 additions & 12 deletions

File tree

README.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,22 +42,38 @@ pytest tests --cov=custom_components/mitsubishi --cov-report=term-missing -v
4242

4343
## Installation
4444

45-
### HACS (Recommended)
45+
### Install using HACS (recommended)
46+
If you do not have HACS installed yet visit https://hacs.xyz for installation instructions.
4647

47-
1. Open HACS in Home Assistant
48-
2. Go to "Integrations"
49-
3. Click the three dots in the top right corner
50-
4. Select "Custom repositories"
51-
5. Add `https://github.com/pymitsubishi/homeassistant-mitsubishi` as an integration
52-
6. Install the integration
53-
7. Restart Home Assistant
48+
To add the this repository to HACS in your Home Assistant instance, use this My button:
49+
50+
[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?repository=homeassistant-mitsubishi&owner=pymitsubishi&category=Integration)
51+
52+
After installation, please restart Home Assistant. To add Mitsubishi Air Conditioner to your Home Assistant instance, use this My button:
53+
54+
[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=homeassistant-mitsubishi)
55+
56+
<details>
57+
<summary><b> Manual configuration steps</b></summary>
58+
59+
### Semi-Manual Installation with HACS
60+
61+
1. In Home Assistant go to HACS integrations section.
62+
2. Click on the 3 dots in the top right corner.
63+
3. Select "Custom repositories".
64+
4. Add the URL (https://github.com/pymitsubishi/homeassistant-mitsubishi) to the repository.
65+
5. Select the integration category.
66+
6. Click the "ADD" button.
67+
7. Now you are able to download the integration.
5468

5569
### Manual Installation
5670

57-
1. Copy the `custom_components/mitsubishi` folder to your `custom_components` directory
58-
2. Restart Home Assistant
59-
3. Go to Configuration → Integrations
60-
4. Click "Add Integration" and search for "Mitsubishi Air Conditioner"
71+
1. Download the [latest release of homeassistant-mitsubishi](https://github.com/pymitsubishi/homeassistant-mitsubishi/releases/latest) and extract its contents.
72+
2. Copy the `mitsubishi` folder into the `custom_components` directory located typically at `/config/custom_components/` in your Home Assistant directory.
73+
3. Restart Home Assistant to recognize the newly added custom component.
74+
<a href="https://my.home-assistant.io/redirect/developer_call_service/?service=homeassistant%2Erestart" target="_blank" rel="noreferrer noopener"><img src="https://my.home-assistant.io/badges/developer_call_service.svg" alt="Open your Home Assistant instance and show your service developer tools with a specific action selected." /></a>
75+
76+
</details>
6177

6278
## Configuration
6379

0 commit comments

Comments
 (0)