From ee7f0625347b2d6c7e2b1681765bde41f8f2450d Mon Sep 17 00:00:00 2001 From: "Community Hass.io Add-ons Bot" Date: Wed, 9 May 2018 19:58:13 +0000 Subject: [PATCH] :books: Updated README --- README.md | 128 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..9c4dc4c06 --- /dev/null +++ b/README.md @@ -0,0 +1,128 @@ +# EDGE - 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 AN EDGE REPOSITORY + +This Hass.io Add-ons repository contains edge builds of add-ons. Edge builds +add-ons are based upon the latest development version. + +- 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 our add-ons: + + + +## 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-edge +``` + +## Add-ons provided by this repository + +## Releases + +Add-on releases are **NOT** based on [Semantic Versioning][semver], unlike +all our other repositories. The latest build commit SHA hash of each +add-on, represents the version number. + +## 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-edge/badges/master/pipeline.svg +[gitlabci]: https://gitlab.com/hassio-addons/repository-edge/pipelines +[issue]: https://github.com/hassio-addons/repository-edge/issues +[license-shield]: https://img.shields.io/github/license/hassio-addons/repository-edge.svg +[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg +[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.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/ \ No newline at end of file