diff --git a/.README.j2 b/.README.j2 new file mode 100644 index 0000000..6ef162f --- /dev/null +++ b/.README.j2 @@ -0,0 +1,81 @@ +# Grott - Home Assistant with native MQTT integration + +[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fegguy%2Fgrott-home-assistant-add-on) + +An addon to allow running the grott software directly on HA. + +This allow to process in local all the data from the growatt datalogger and don't depend on growatt server. + +This addon allow you to have all the entities automatically created. + + +## Add-ons provided by this repository + +{% for addon in addons %} +### ✓ [{{ addon.name }}][addon-{{ addon.target }}] + +![Latest Version][{{ addon.target }}-version-shield] +![Supports armhf Architecture][{{ addon.target }}-armhf-shield] +![Supports armv7 Architecture][{{ addon.target }}-armv7-shield] +![Supports aarch64 Architecture][{{ addon.target }}-aarch64-shield] +![Supports amd64 Architecture][{{ addon.target }}-amd64-shield] +![Supports i386 Architecture][{{ addon.target }}-i386-shield] + +{{ addon.description }} + +[:books: {{ addon.name }} add-on documentation][addon-doc-{{ addon.target }}] + +{% endfor %} + +## Releases + +Releases are based on [Semantic Versioning][semver], and use the format +of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +based on the following: + +- ``MAJOR``: Incompatible or major changes. +- ``MINOR``: Backwards-compatible new features and enhancements. +- ``PATCH``: Backwards-compatible bugfixes and package updates. + +You could also open an issue here on GitHub. Note, we use a separate +GitHub repository for each add-on. Please ensure you are creating the issue +on the correct GitHub repository matching the add-on. + +{% for addon in addons %} +- [Open an issue for the add-on: {{ addon.name }}][{{ addon.target }}-issue] +{% endfor %} + +For a general repository issue or add-on ideas [open an issue here][issue] + + + +{% for addon in addons %} +[addon-{{ addon.target }}]: {{ addon.repo }}/tree/{{ addon.version }} +[addon-doc-{{ addon.target}}]: {{ addon.repo }}/blob/{{ addon.version }}/README.md +[{{ addon.target }}-issue]: {{ addon.repo }}/issues +[{{ addon.target }}-version-shield]: https://img.shields.io/badge/version-{{ addon.version }}-blue.svg +{% for arch in ['aarch64', 'amd64', 'armhf', 'armv7', 'i386'] %} +{% if arch in addon.archs %} +[{{ addon.target }}-{{ arch }}-shield]: https://img.shields.io/badge/{{ arch }}-yes-green.svg +{% else %} +[{{ addon.target }}-{{ arch }}-shield]: https://img.shields.io/badge/{{ arch }}-no-red.svg +{% endif %} +{% endfor %} +{% endfor %} + +## contributors + +Thanks for all the contributors: + +- [alelio](https://github.com/alelio) +- [perico85](https://github.com/perico85) +- [crazymonster999](https://github.com/crazymonster999) - Alpha tester +- Zigbee2mqtt for the inspiration + +[gitlabci-shield]: https://gitlab.com/{{ name }}/badges/master/pipeline.svg +[gitlabci]: https://gitlab.com/{{ name }}/pipelines +[issue]: https://github.com/{{ name }}/issues +[license-shield]: https://img.shields.io/github/license/{{ name }}.svg +[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg +[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg +[semver]: http://semver.org/spec/v2.0.0.html diff --git a/.addons.yml b/.addons.yml index 1a34df0..22c1d32 100644 --- a/.addons.yml +++ b/.addons.yml @@ -5,7 +5,7 @@ addons: repository: egguy/addon-grott target: grott image: ghcr.io/egguy/grott/{arch} - grott-beta: + grott-current: repository: egguy/addon-grott-beta target: grott-beta image: ghcr.io/egguy/grott-beta/{arch}