diff --git a/README.md b/README.md new file mode 100644 index 0000000..cb6f938 --- /dev/null +++ b/README.md @@ -0,0 +1,105 @@ +# BETA Home Assistant Add-ons by Daniel Figus + +![Project Stage][project-stage-shield] +![Maintenance][maintenance-shield] +[![License][license-shield]](LICENSE.md) + + +## WARNING! THIS IS AN BETA REPOSITORY + +This Home Assistant Add-ons repository contains beta releases of add-ons. + +- They may not work at all. +- 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. +- Developers. + +If you are more interested in stable releases of my add-ons: + + + +## Installation + +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 +https://github.com/dfigus/hassio-addons-beta +``` + +[![Opens your Home Assistant instance and show the add add-on repository dialog with the repository URL pre-filled](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)][my-ha-add-repo] + +## 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. + +## Support + +Got questions? + +You have several options to get them answered: + +- The Home Assistant [Community Forum][forum]. +- You could also [open an issue here][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: + +## License + +MIT License + +Copyright (c) 2023-2024 Daniel Figus + +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. + +[dfigus]: https://github.com/dfigus +[issue]: https://github.com/dfigus/hassio-addons-beta/issues +[license-shield]: https://img.shields.io/github/license/dfigus/hassio-addons-beta.svg +[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg +[my-ha-add-repo]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fdfigus%2Fhassio-addons +[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg +[semver]: http://semver.org/spec/v2.0.0.html \ No newline at end of file