From 94873555976dfa53451a1c7f483cf9d58edab25e Mon Sep 17 00:00:00 2001 From: jimmykmi Date: Tue, 17 Dec 2024 19:43:36 +0800 Subject: [PATCH 1/2] docs: Updated README.md to include instructions for installing the integration via HACS --- README.md | 8 ++++++-- doc/README_zh.md | 8 ++++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6f97f2a..4d318ac 100644 --- a/README.md +++ b/README.md @@ -32,9 +32,13 @@ git checkout v1.0.0 ### Method 2: [HACS](https://hacs.xyz/) -HACS > Overflow Menu > Custom repositories > Repository: https://github.com/XiaoMi/ha_xiaomi_home.git & Category: Integration > ADD +One-click installation of the Xiaomi Home integration from HACS: + +[![Open your Home Assistant instance and start setting up a new integration with HACS.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=XiaoMi&repository=ha_xiaomi_home&category=integration) -> Xiaomi Home has not been added to the HACS store as a default yet. It's coming soon. +If the one-click installation fails, you can manually install it using HACS: + +HACS > Overflow Menu > Custom repositories > Repository: https://github.com/XiaoMi/ha_xiaomi_home.git & Category: Integration > ADD ### Method 3: Manually installation via [Samba](https://github.com/home-assistant/addons/tree/master/samba) / [FTPS](https://github.com/hassio-addons/addon-ftp) diff --git a/doc/README_zh.md b/doc/README_zh.md index cee5c67..e0e77d0 100644 --- a/doc/README_zh.md +++ b/doc/README_zh.md @@ -32,9 +32,13 @@ git checkout v1.0.0 ### 方法 2: [HACS](https://hacs.xyz/) -HACS > Overflow Menu > Custom repositories > Repository: https://github.com/XiaoMi/ha_xiaomi_home.git & Category: Integration > ADD +一键从 HACS 安装米家集成： + +[![Open your Home Assistant instance and start setting up a new integration with HACS.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=XiaoMi&repository=ha_xiaomi_home&category=integration) -> 米家集成暂未添加到 HACS 商店，敬请期待。 +若一键安装失败，可使用HACS手动安装： + +HACS > Overflow Menu > Custom repositories > Repository: https://github.com/XiaoMi/ha_xiaomi_home.git & Category: Integration > ADD ### 方法 3：通过 [Samba](https://github.com/home-assistant/addons/tree/master/samba) 或 [FTPS](https://github.com/hassio-addons/addon-ftp) 手动安装 From 54e1fe366acb3826fd9d2bb07786bd378d45e98a Mon Sep 17 00:00:00 2001 From: JimmyKmi Date: Sun, 22 Dec 2024 23:20:54 +0800 Subject: [PATCH 2/2] docs: Correct the information in the readme. --- README.md | 10 +++------- doc/README_zh.md | 10 +++------- 2 files changed, 6 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index fb39e68..332c0e4 100644 --- a/README.md +++ b/README.md @@ -34,11 +34,7 @@ git checkout v1.0.0 One-click installation of the Xiaomi Home integration from HACS: -[![Open your Home Assistant instance and start setting up a new integration with HACS.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=XiaoMi&repository=ha_xiaomi_home&category=integration) - -If the one-click installation fails, you can manually install it using HACS: - -HACS > Overflow Menu > Custom repositories > Repository: https://github.com/XiaoMi/ha_xiaomi_home.git & Category: Integration > ADD +[![Open your Home Assistant instance and open the Xiaomi Home integration inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=XiaoMi&repository=ha_xiaomi_home&category=integration) ### Method 3: Manually installation via [Samba](https://github.com/home-assistant/addons/tree/master/samba) / [FTPS](https://github.com/hassio-addons/addon-ftp) @@ -50,7 +46,7 @@ Download and copy `custom_components/xiaomi_home` folder to `config/custom_compo [Settings > Devices & services > ADD INTEGRATION](https://my.home-assistant.io/redirect/brand/?brand=xiaomi_home) > Search `Xiaomi Home` > NEXT > Click here to login > Sign in with Xiaomi account -[![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=xiaomi_home) +[![Open your Home Assistant instance and start setting up a new Xiaomi Home integration instance.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=xiaomi_home) ### Add MIoT Devices @@ -62,7 +58,7 @@ After a Xiaomi account login and its user configuration are completed, you can c Method: [Settings > Devices & services > Configured > Xiaomi Home](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home) > ADD HUB > NEXT > Click here to login > Sign in with Xiaomi account -[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home) +[![Open your Home Assistant instance and show Xiaomi Home integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home) ### Update Configurations diff --git a/doc/README_zh.md b/doc/README_zh.md index 7f99b2f..aef7964 100644 --- a/doc/README_zh.md +++ b/doc/README_zh.md @@ -34,11 +34,7 @@ git checkout v1.0.0 一键从 HACS 安装米家集成： -[![Open your Home Assistant instance and start setting up a new integration with HACS.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=XiaoMi&repository=ha_xiaomi_home&category=integration) - -若一键安装失败，可使用HACS手动安装： - -HACS > Overflow Menu > Custom repositories > Repository: https://github.com/XiaoMi/ha_xiaomi_home.git & Category: Integration > ADD +[![打开您的 Home Assistant 实例并打开 Home Assistant 社区商店内的米家集成。](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=XiaoMi&repository=ha_xiaomi_home&category=integration) ### 方法 3：通过 [Samba](https://github.com/home-assistant/addons/tree/master/samba) 或 [FTPS](https://github.com/hassio-addons/addon-ftp) 手动安装 @@ -50,7 +46,7 @@ HACS > Overflow Menu > Custom repositories > Repository: https://github.com/Xiao [设置 > 设备与服务 > 添加集成](https://my.home-assistant.io/redirect/brand/?brand=xiaomi_home) > 搜索“`Xiaomi Home`” > 下一步 > 请点击此处进行登录 > 使用小米账号登录 -[![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=xiaomi_home) +[![打开您的 Home Assistant 实例并开始配置一个新的米家集成实例。](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=xiaomi_home) ### 添加 MIoT 设备 @@ -62,7 +58,7 @@ HACS > Overflow Menu > Custom repositories > Repository: https://github.com/Xiao 方法：[设置 > 设备与服务 > 已配置 > Xiaomi Home](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home) > 添加中枢 > 下一步 > 请点击此处进行登录 > 使用小米账号登录 -[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home) +[![打开您的 Home Assistant 实例并显示米家集成。](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=xiaomi_home) ### 修改配置项