Template
Update README.md
This commit is contained in:
@@ -1,4 +1,4 @@
|
|||||||
# Integration Name
|
# $REPO_NAME Integration for Home Assistant
|
||||||
|
|
||||||
[![GitHub Release][releases-shield]][releases]
|
[![GitHub Release][releases-shield]][releases]
|
||||||
[![GitHub Activity][commits-shield]][commits]
|
[![GitHub Activity][commits-shield]][commits]
|
||||||
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
[![hacs][hacsbadge]][hacs]
|
[![hacs][hacsbadge]][hacs]
|
||||||
|
|
||||||
Integration for Home Assistant to control {description}.
|
Integration for Home Assistant to control $REPO_NAME devices.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@@ -15,16 +15,16 @@ Integration for Home Assistant to control {description}.
|
|||||||
1. Open HACS in Home Assistant
|
1. Open HACS in Home Assistant
|
||||||
2. Go to "Integrations"
|
2. Go to "Integrations"
|
||||||
3. Click "+" button
|
3. Click "+" button
|
||||||
4. Search for "{integration_name}"
|
4. Search for "$REPO_NAME"
|
||||||
5. Click "Install"
|
5. Click "Install"
|
||||||
6. Restart Home Assistant
|
6. Restart Home Assistant
|
||||||
|
|
||||||
### Manual Installation
|
### Manual Installation
|
||||||
|
|
||||||
1. Copy `custom_components/{integration_name}` folder to your Home Assistant `custom_components` directory
|
1. Copy `custom_components/$REPO_NAME` folder to your Home Assistant `custom_components` directory
|
||||||
2. Restart Home Assistant
|
2. Restart Home Assistant
|
||||||
3. Go to Settings > Devices & Services > Add Integration
|
3. Go to Settings > Devices & Services > Add Integration
|
||||||
4. Search for "{integration_name}"
|
4. Search for "$REPO_NAME"
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
@@ -32,7 +32,7 @@ After installation, configure the integration through the Home Assistant UI:
|
|||||||
|
|
||||||
1. Go to Settings > Devices & Services
|
1. Go to Settings > Devices & Services
|
||||||
2. Click "Add Integration"
|
2. Click "Add Integration"
|
||||||
3. Search for "{integration_name}"
|
3. Search for "$REPO_NAME"
|
||||||
4. Follow the configuration steps
|
4. Follow the configuration steps
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
@@ -57,10 +57,10 @@ Contributions are welcome! Please feel free to submit a Pull Request.
|
|||||||
|
|
||||||
This project is under the MIT license.
|
This project is under the MIT license.
|
||||||
|
|
||||||
[commits-shield]: https://img.shields.io/github/commit-activity/y/USERNAME/REPO_NAME.svg
|
[commits-shield]: https://img.shields.io/github/commit-activity/y/$USER_NAME/$REPO_NAME.svg
|
||||||
[commits]: https://github.com/USERNAME/REPO_NAME/commits/main
|
[commits]: https://github.com/$USER_NAME/$REPO_NAME/commits/main
|
||||||
[hacs]: https://hacs.xyz
|
[hacs]: https://hacs.xyz
|
||||||
[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg
|
[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg
|
||||||
[license-shield]: https://img.shields.io/github/license/USERNAME/REPO_NAME.svg
|
[license-shield]: https://img.shields.io/github/license/$USER_NAME/$REPO_NAME.svg
|
||||||
[releases-shield]: https://img.shields.io/github/release/USERNAME/REPO_NAME.svg
|
[releases-shield]: https://img.shields.io/github/release/$USER_NAME/$REPO_NAME.svg
|
||||||
[releases]: https://github.com/USERNAME/REPO_NAME/releases
|
[releases]: https://github.com/$USER_NAME/$REPO_NAME/releases
|
||||||
Reference in New Issue
Block a user