mirror of
https://github.com/hassio-addons/repository-edge.git
synced 2025-05-05 11:41:31 +00:00
63 lines
No EOL
2.4 KiB
Markdown
63 lines
No EOL
2.4 KiB
Markdown
# Community Hass.io Add-ons: Example
|
|
|
|
[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
|
|
|
|
[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
|
|
|
|
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
|
|
|
|
[![Support my work on Patreon][patreon-shield]][patreon]
|
|
|
|
Example add-on by Community Hass.io add-ons.
|
|
|
|
## About
|
|
|
|
This is an example add-on for Hass.io. When started, it displays a
|
|
random quote every 5 seconds.
|
|
|
|
It shows off several features and structures like:
|
|
|
|
- Full blown GitHub repository.
|
|
- General Dockerfile structure and setup.
|
|
- The use of the `config.json` and `build.json` files.
|
|
- General shell scripting structure (`run.sh`).
|
|
- Quality assurance using CodeClimate.
|
|
- Continuous integration and deployment using CircleCI.
|
|
- Usage of the Community Hass.io Add-ons build environment.
|
|
- Small use of the Bash function library in our base images.
|
|
- The use of Docker label schema.
|
|
|
|
[Click here for the full documentation][docs]
|
|
|
|
## WARNING! THIS IS AN EDGE VERSION!
|
|
|
|
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:
|
|
|
|
<https://github.com/hassio-addons/repository>
|
|
|
|
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
|
|
[buymeacoffee]: https://www.buymeacoffee.com/frenck
|
|
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
|
[discord]: https://discord.me/hassioaddons
|
|
[docs]: https://github.com/hassio-addons/addon-example/blob/43d3c2a/README.md
|
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
|
[forum]: https://community.home-assistant.io?u=frenck
|
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg
|
|
[patreon-shield]: https://www.frenck.nl/images/patreon.png
|
|
[patreon]: https://www.patreon.com/frenck
|
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
|
|
[release-shield]: https://img.shields.io/badge/version-43d3c2a-blue.svg
|
|
[release]: https://github.com/hassio-addons/addon-example/tree/43d3c2a |