diff --git a/README.md b/README.md index 8e391de..6347815 100644 --- a/README.md +++ b/README.md @@ -13,21 +13,19 @@ ## Installation (with HACS) -1. If you've previously installed this integration, delete it first from Settings -> Integrations -2. In Home Assistant, go to HACS -> Integrations -3. On the top right, click the 3 dots and select "Custom repositories" -4. If you've previously installed this integration, make sure you delete `https://github.com/bentekkie/ha-generac` from the list of existing repositories (and delete the integration as mentioned in Step 1!) -5. In the form at the bottom of the popup, enter `https://github.com/binarydev/ha-generac` into the Repository field, and select `Integration` in the Category dropdown field -6. Click the Add button and close the popup -7. On the HACS -> Integrations page, click the `Explore & Download Repositories` button -8. Search the list for `generac` and select it to open the details page -9. On the bottom right, click the `Download` button -10. Restart Home Assistant (not the quick reload option) -11. Once Home Assistant comes back online, go to Settings -> Integrations -12. Click the `Add Integration` button -13. Search the list for `generac` and select it -14. Enter the credentials you use to login for https://app.mobilelinkgen.com/ and submit the form -15. The integration should initialize and begin pulling your device information within seconds +> _NOTE:_ If you've previously installed this integration, delete it first from Settings -> Integrations and delete the "Custom Repository" entry in HACS (found in HACS -> Integrations -> 3 dot menu on the top right) + +Click this button to skip steps 1 and 2 below: [![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/?owner=binarydev&repository=ha-generac&category=Integration) + +1. On the HACS -> Integrations page, click the `Explore & Download Repositories` button +2. Search the list for `generac` and select it to open the details page +3. On the bottom right, click the `Download` button +4. Restart Home Assistant (not the quick reload option) +5. Once Home Assistant comes back online, go to Settings -> Integrations +6. Click the `Add Integration` button +7. Search the list for `generac` and select it +8. Enter the credentials you use to login for https://app.mobilelinkgen.com/ and submit the form +9. The integration should initialize and begin pulling your device information within seconds ## Installation (without HACS) diff --git a/info.md b/info.md index 531202a..a474175 100644 --- a/info.md +++ b/info.md @@ -16,7 +16,9 @@ ## Installation 1. Click install. -1. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "generac". +2. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "generac". +3. Enter the credentials you use to login for https://app.mobilelinkgen.com/ and submit the form +4. The integration should initialize and begin pulling your device information within seconds {% endif %} @@ -24,6 +26,10 @@ +## Contributions are welcome! + +If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md) + ## Credits This project was generated from [@oncleben31](https://github.com/oncleben31)'s [Home Assistant Custom Component Cookiecutter](https://github.com/oncleben31/cookiecutter-homeassistant-custom-component) template. @@ -35,7 +41,9 @@ Forked from the original implementation created by [@bentekkie](https://github.c --- [integration_blueprint]: https://github.com/custom-components/integration_blueprint -[buymecoffee]: https://www.buymeacoffee.com/ludeeus +[black]: https://github.com/psf/black +[black-shield]: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge +[buymecoffee]: https://www.buymeacoffee.com/bentekkie [buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge [commits-shield]: https://img.shields.io/github/commit-activity/y/bentekkie/ha-generac.svg?style=for-the-badge [commits]: https://github.com/binarydev/ha-generac/commits/main @@ -46,9 +54,10 @@ Forked from the original implementation created by [@bentekkie](https://github.c [exampleimg]: example.png [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge [forum]: https://community.home-assistant.io/ -[license]: https://github.com/binarydev/ha-generac/blob/main/LICENSE -[license-shield]: https://img.shields.io/github/license/bentekkie/ha-generac.svg?style=for-the-badge -[maintenance-shield]: https://img.shields.io/badge/maintainer-%40bentekkie-blue.svg?style=for-the-badge -[releases-shield]: https://img.shields.io/github/release/bentekkie/ha-generac.svg?style=for-the-badge +[license-shield]: https://img.shields.io/github/license/binarydev/ha-generac.svg?style=for-the-badge +[maintenance-shield]: https://img.shields.io/badge/maintainer-%40binarydev-blue.svg?style=for-the-badge +[pre-commit]: https://github.com/pre-commit/pre-commit +[pre-commit-shield]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=for-the-badge +[releases-shield]: https://img.shields.io/github/release/binarydev/ha-generac.svg?style=for-the-badge [releases]: https://github.com/binarydev/ha-generac/releases [user_profile]: https://github.com/binarydev