From 766d736b43f36d6cdafb979f42127fbbb49b0506 Mon Sep 17 00:00:00 2001 From: sirmrak Date: Wed, 22 Jul 2026 13:46:08 +0300 Subject: [PATCH] Add README.md --- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ee14f89 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# Integration Name + +[![GitHub Release][releases-shield]][releases] +[![GitHub Activity][commits-shield]][commits] +[![License][license-shield]](LICENSE) + +[![hacs][hacsbadge]][hacs] + +Integration for Home Assistant to control {description}. + +## Installation + +### HACS (Recommended) + +1. Open HACS in Home Assistant +2. Go to "Integrations" +3. Click "+" button +4. Search for "{integration_name}" +5. Click "Install" +6. Restart Home Assistant + +### Manual Installation + +1. Copy `custom_components/{integration_name}` folder to your Home Assistant `custom_components` directory +2. Restart Home Assistant +3. Go to Settings > Devices & Services > Add Integration +4. Search for "{integration_name}" + +## Configuration + +After installation, configure the integration through the Home Assistant UI: + +1. Go to Settings > Devices & Services +2. Click "Add Integration" +3. Search for "{integration_name}" +4. Follow the configuration steps + +## Features + +- Feature 1 +- Feature 2 +- Feature 3 + +## Development + +### Beta Versions + +To test beta versions: +1. Enable "Show beta versions" in HACS settings +2. Update the integration to the latest beta version + +### Contributing + +Contributions are welcome! Please feel free to submit a Pull Request. + +## License + +This project is under the MIT license. + +[commits-shield]: https://img.shields.io/github/commit-activity/y/USERNAME/REPO_NAME.svg +[commits]: https://github.com/USERNAME/REPO_NAME/commits/main +[hacs]: https://hacs.xyz +[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg +[license-shield]: https://img.shields.io/github/license/USERNAME/REPO_NAME.svg +[releases-shield]: https://img.shields.io/github/release/USERNAME/REPO_NAME.svg +[releases]: https://github.com/USERNAME/REPO_NAME/releases \ No newline at end of file