Skip to content

Commit

Permalink
fix hacs info readme
Browse files Browse the repository at this point in the history
  • Loading branch information
litinoveweedle committed Jun 3, 2024
1 parent 1ba856e commit e3dc83b
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 7 deletions.
7 changes: 6 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
[![](https://img.shields.io/github/v/release/litinoveweedle/SmartIR.svg?style=flat-square)](https://github.com/litinoveweedle/SmartIR/releases/latest) [![](https://img.shields.io/badge/HACS-Custom-orange.svg?style=flat-square)](https://github.com/custom-components/hacs)
# ⏻ Smart IR

[![HACS Badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)
[![License](https://img.shields.io/github/license/litinoveweedle/smartir?style=for-the-badge)](https://github.com/litinoveweedle/smartir/blob/main/LICENSE)
[![Latest Release](https://img.shields.io/github/v/release/litinoveweedle/smartir?style=for-the-badge)
[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://github.com/psf/black)

## Overview
SmartIR is a custom integration for controlling **climate devices**, **media players** and **fans** via infrared controllers.
Expand Down
3 changes: 1 addition & 2 deletions hacs.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@
"persistent_directory": "custom_codes",
"zip_release": true,
"hide_default_branch": true,
"filename": "smartir.zip",
"render_readme": true
"filename": "smartir.zip"
}
29 changes: 25 additions & 4 deletions info.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
SmartIR is a custom integration for controlling **climate devices**, **media players** and **fans** via infrared controllers.<br>
# ⏻ Smart IR

[![HACS Badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)
[![License](https://img.shields.io/github/license/litinoveweedle/smartir?style=for-the-badge)](https://github.com/litinoveweedle/smartir/blob/main/LICENSE)
[![Latest Release](https://img.shields.io/github/v/release/litinoveweedle/smartir?style=for-the-badge)
[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://github.com/psf/black)

## Overview
SmartIR is a custom integration for controlling **climate devices**, **media players** and **fans** via infrared controllers.

SmartIR currently supports the following controllers:
* [Broadlink](https://www.home-assistant.io/integrations/broadlink/)
* [Xiaomi IR Remote (ChuangmiIr)](https://www.home-assistant.io/integrations/remote.xiaomi_miio/)
Expand All @@ -8,6 +17,18 @@ SmartIR currently supports the following controllers:
* [Tuya Z06/Moes UFO-R11](https://www.zigbee2mqtt.io/devices/UFO-R11.html)
* [ZHA Zigbee IR remote](https://www.home-assistant.io/integrations/zha/) (May require custom zha quirk for given controller)

More than 120 climate devices are currently supported out-of-the-box, mainly for the Broadlink controller, thanks to our awesome community.<br>
Please don't forget to [**star**](https://github.com/smartHomeHub/SmartIR/) the repository if you had fun! [**"Buy Me A Coffee**"](https://www.buymeacoffee.com/vassilis) is also welcome. It will help in further development.<br>
[Read the documents for detailed instructions on how to configure SmartIR.](https://github.com/smartHomeHub/SmartIR/)
More than 120 climate devices are currently supported out-of-the-box, mainly for the Broadlink controller, thanks to our awesome community.

Don't forget to **star** the repository if you had fun!

## Disclaimer ##

This is a fork of the original repository smartHomeHub/SmartIR which seems to be unmaintained at the time with many pull requests pending. As some of those were useful to my usage I decided to fork and merge the work of the corresponding authors to allow for simple usage of the integration through HACS. Therefore all the corresponding rights belong to the original authors. I also lately started to fix some additional users issues, implementing HomeAssistant future compatibility changes and adding some functionality, trying to keep compatibility but please note, that there may be some **breaking changes** from the original version.

### WARNING - custom codes! ###

If you use any own/custom codes json files please backup such json files before migrating to this integration from the original one. After instalation (using HACS) please place your custom files into new `custom_codes` directory. `codes` directory is managed by HACS and you will loose all changes during any HACS update!S

## Documentation ##

[Read the documents for detailed instructions on how to configure SmartIR.](https://github.com/litinoveweedle/SmartIR/)

0 comments on commit e3dc83b

Please sign in to comment.