mirror of
https://github.com/hassio-addons/repository-beta.git
synced 2025-05-04 19:11:30 +00:00
📚 Updated README
This commit is contained in:
parent
cc65f8c722
commit
7ddfdf1a0a
1 changed files with 133 additions and 0 deletions
133
README.md
Normal file
133
README.md
Normal file
|
@ -0,0 +1,133 @@
|
||||||
|
# BETA - Community Hass.io Add-ons for Home Assistant
|
||||||
|
|
||||||
|
![Project Stage][project-stage-shield]
|
||||||
|
![Maintenance][maintenance-shield]
|
||||||
|
[![License][license-shield]](LICENSE.md)
|
||||||
|
|
||||||
|
[![GitLab CI][gitlabci-shield]][gitlabci]
|
||||||
|
![Awesome][awesome-shield]
|
||||||
|
|
||||||
|
[![Discord][discord-shield]][discord]
|
||||||
|
[![Community Forum][forum-shield]][forum]
|
||||||
|
|
||||||
|
## WARNING! THIS IS A BETA REPOSITORY
|
||||||
|
|
||||||
|
This Hass.io Add-ons repository contains beta releases of add-ons.
|
||||||
|
|
||||||
|
- They might stop working at any time.
|
||||||
|
- They could have a negative impact on your system.
|
||||||
|
|
||||||
|
This repository was created for:
|
||||||
|
|
||||||
|
- Anybody willing to test.
|
||||||
|
- Anybody interested in trying out upcoming add-ons or add-on features.
|
||||||
|
|
||||||
|
If you are more interested in stable releases of our add-ons:
|
||||||
|
|
||||||
|
<https://github.com/hassio-addons/repository>
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Adding this add-ons repository to your Hass.io Home Assistant instance is
|
||||||
|
pretty easy. Follow [the official instructions][third-party-addons] on the
|
||||||
|
website of Home Assistant, and use the following URL:
|
||||||
|
|
||||||
|
```txt
|
||||||
|
https://github.com/hassio-addons/repository-beta
|
||||||
|
```
|
||||||
|
|
||||||
|
## Add-ons provided by this repository
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
The beta add-ons will also have an additional beta marker, unless, the
|
||||||
|
stable release is newer, in that case, the stable release is published
|
||||||
|
in this channel.
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
Got questions?
|
||||||
|
|
||||||
|
You have several options to get them answered:
|
||||||
|
|
||||||
|
- The Home Assistant [Community Forum][forum].
|
||||||
|
- The Home Assistant [Discord Chat Server][discord].
|
||||||
|
- 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 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
|
||||||
|
|
||||||
|
Have you created an add-on that you want to list in the Community Repository?
|
||||||
|
Contact [Franck Nijhof][frenck]:
|
||||||
|
|
||||||
|
- Drop him an email: frenck@addons.community
|
||||||
|
- Chat with him on [Discord Chat][discord]: Frenck#4484 (@frenck)
|
||||||
|
- Message him via the forums: [frenck][forum-frenck]
|
||||||
|
|
||||||
|
He will set up a GitHub repository and all the other plumbing,
|
||||||
|
and of course, give you developer access to your contribution.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2018 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.
|
||||||
|
|
||||||
|
[awesome-shield]: https://img.shields.io/badge/awesome%3F-yes-brightgreen.svg
|
||||||
|
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg
|
||||||
|
[discord]: https://discord.gg/c5DvZ4e
|
||||||
|
[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/hassio-addons/repository-beta/badges/master/pipeline.svg
|
||||||
|
[gitlabci]: https://gitlab.com/hassio-addons/repository-beta/pipelines
|
||||||
|
[issue]: https://github.com/hassio-addons/repository-beta/issues
|
||||||
|
[license-shield]: https://img.shields.io/github/license/hassio-addons/repository-beta.svg
|
||||||
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg
|
||||||
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-development-yellowgreen.svg
|
||||||
|
[reddit]: https://reddit.com/r/homeassistant
|
||||||
|
[semver]: http://semver.org/spec/v2.0.0.html
|
||||||
|
[third-party-addons]: https://home-assistant.io/hassio/installing_third_party_addons/
|
Loading…
Add table
Add a link
Reference in a new issue