init
This commit is contained in:
157
.README.j2
Normal file
157
.README.j2
Normal file
@@ -0,0 +1,157 @@
|
||||
# Home Assistant Community Add-ons
|
||||
|
||||
![Project Stage][project-stage-shield]
|
||||
![Maintenance][maintenance-shield]
|
||||
[![License][license-shield]](LICENSE.md)
|
||||
|
||||
[![Discord][discord-shield]][discord]
|
||||
[![Community Forum][forum-shield]][forum]
|
||||
|
||||
## About
|
||||
|
||||
Home Assistant allows anyone to create add-on repositories to share their
|
||||
add-ons for Home Assistant easily. This repository is one of those repositories,
|
||||
providing extra Home Assistant add-ons for your installation.
|
||||
|
||||
The primary goal of this project is to provide you (as a Home Assistant user)
|
||||
with additional, high quality, add-ons that allow you to take your automated
|
||||
home to the next level.
|
||||
|
||||
## Installation
|
||||
|
||||
In general, there is no need to install this repository on your
|
||||
Home Assistant instance. It is activated and added by Home Assistant
|
||||
by default.
|
||||
|
||||
However, if the repository is missing on your setup, adding this add-ons
|
||||
repository to your Home Assistant instance is pretty easy. In the
|
||||
Home Assistant add-on store, a possibility to add a repository is provided.
|
||||
|
||||
Use the following URL to add this repository:
|
||||
|
||||
```txt
|
||||
{{ repo }}
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
## Support
|
||||
|
||||
Got questions?
|
||||
|
||||
You have several options to get them answered:
|
||||
|
||||
- The Home Assistant Community Add-ons [Discord Chat Server][discord]
|
||||
- The Home Assistant [Community Forum][forum].
|
||||
- The Home Assistant [Discord Chat Server][discord-ha].
|
||||
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
|
||||
|
||||
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]
|
||||
|
||||
## Contributing
|
||||
|
||||
This is an active open-source project. We are always open to people who want to
|
||||
use the code or contribute to it.
|
||||
|
||||
We have set up a separate document containing our
|
||||
[contribution guidelines](CONTRIBUTING.md).
|
||||
|
||||
Thank you for being involved! :heart_eyes:
|
||||
|
||||
## Adding a new add-on
|
||||
|
||||
We are currently not accepting third party add-ons to this repository.
|
||||
|
||||
For questions, please contact [Franck Nijhof][frenck]:
|
||||
|
||||
- Drop him an email: frenck@addons.community
|
||||
- Chat with him on [Discord Chat][discord]
|
||||
- Message him via the forums: [frenck][forum-frenck]
|
||||
|
||||
## License
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2017-2021 Franck Nijhof
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
{% 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 %}
|
||||
[awesome-shield]: https://img.shields.io/badge/awesome%3F-yes-brightgreen.svg
|
||||
[awesome]: https://awesome-ha.com
|
||||
[discord-ha]: https://discord.gg/c5DvZ4e
|
||||
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||
[discord]: https://discord.me/hassioaddons
|
||||
[forum-frenck]: https://community.home-assistant.io/u/frenck/?u=frenck
|
||||
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||||
[forum]: https://community.home-assistant.io?u=frenck
|
||||
[frenck]: https://github.com/frenck
|
||||
[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/2021.svg
|
||||
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
|
||||
[reddit]: https://reddit.com/r/homeassistant
|
||||
[semver]: http://semver.org/spec/v2.0.0.html
|
||||
Reference in New Issue
Block a user