📚 Update of README.md adding the Homebridge add-on

This commit is contained in:
Franck Nijhof 2017-08-14 17:42:11 +02:00 committed by Franck Nijhof
parent 64114b2a18
commit e55a59b1c2
No known key found for this signature in database
GPG key ID: D62583BA8AB11CA3

View file

@ -5,13 +5,19 @@
![Awesome][awesome-shield]
[![License][license-shield]](LICENSE.md)
Hass.io allows anyone to create add-on repositories to share their add-ons for Hass.io easily. This repository is one of those repositories, providing extra Home Assistant add-ons for your Hass.io installation.
Hass.io allows anyone to create add-on repositories to share their add-ons for
Hass.io easily. This repository is one of those repositories, providing extra
Home Assistant add-ons for your Hass.io installation.
The primary goal of this project is to provide you (as a Hass.io / Home Assistant user) with additional, high quality, add-ons that allows you to take your automated home to the next level.
The primary goal of this project is to provide you (as a Hass.io /
Home Assistant user) with additional, high quality, add-ons that allow you to
take your automated home to the next level.
## 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:
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
@ -19,7 +25,25 @@ https://github.com/hassio-addons/repository
## Add-ons provided by this repository
None yet... check back later :)
### ✓ [Homebridge](homebridge)
![Latest Version][homebridge-version-shield]
![Supports armhf Architecture][homebridge-armhf-shield]
![Supports aarch64 Architecture][homebridge-aarch64-shield]
![Supports amd64 Architecture][homebridge-amd64-shield]
![Supports i386 Architecture][homebridge-i386-shield]
![Docker Pulls][homebridge-pulls-shield]
Homebridge is a server that emulates the iOS HomeKit API, allowing you to
control your Home Assistant through via Apple devices (including Siri).
[:books: Homebridge add-on documentation](homebridge)
## Changelog
This add-on repository itself does not keep a change log, the individual
add-ons, however, do. The format is based on [Keep a Changelog][keepchangelog]
and these add-ons adheres to [Semantic Versioning][semver].
## Contributing
@ -31,18 +55,51 @@ We've set up a separate document for our [contribution guidelines](CONTRIBUTING.
Thank you for being involved! :heart_eyes:
We are also looking for maintainers!
Please send [Franck Nijhof][frenck] an email when you are interested into becoming one.
Please send [Franck Nijhof][frenck] an message when you are interested in becoming one.
## Authors & contributors
The original setup of this repository is by [Franck Nijhof][frenck].
For a full list off all author and/or contributors, check [the contributors page][contributors].
For a full list of all authors and contributors,
check [the contributor's page][contributors].
## License
MIT License
Copyright (c) 2017 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.
[third-party-addons]: https://home-assistant.io/hassio/installing_third_party_addons/
[awesome-shield]: https://img.shields.io/badge/awesome%3F-yes-brightgreen.svg
[contributors]: https://github.com/hassio-addons/repository/graphs/contributors
[frenck]: https://github.com/frenck
[homebridge-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[homebridge-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[homebridge-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
[homebridge-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
[homebridge-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/homebridge-armhf.svg
[homebridge-version-shield]: https://images.microbadger.com/badges/version/hassioaddons/homebridge-armhf.svg
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
[license-shield]: https://img.shields.io/github/license/hassio-addons/repository.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2017.svg
[project-stage-shield]: https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg
[semver]: http://semver.org/spec/v2.0.0.html
[third-party-addons]: https://home-assistant.io/hassio/installing_third_party_addons/