From a2413aacacecc63a146b8acd6c8317570921e054 Mon Sep 17 00:00:00 2001 From: "Community Hass.io Add-ons Bot" Date: Thu, 10 May 2018 18:16:50 +0000 Subject: [PATCH] :arrow_up: Updating add-on Example to 8dc7c6e --- README.md | 6 ++--- example/CHANGELOG.md | 23 +++++++++------- example/README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++ example/config.json | 2 +- 4 files changed, 79 insertions(+), 14 deletions(-) create mode 100644 example/README.md diff --git a/README.md b/README.md index 6857689bf..5e5222e35 100644 --- a/README.md +++ b/README.md @@ -319,10 +319,10 @@ SOFTWARE. [appdaemon3-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [appdaemon3-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [appdaemon3-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-example]: https://github.com/hassio-addons/addon-example/tree/61f89b2 -[addon-doc-example]: https://github.com/hassio-addons/addon-example/blob/61f89b2/README.md +[addon-example]: https://github.com/hassio-addons/addon-example/tree/8dc7c6e +[addon-doc-example]: https://github.com/hassio-addons/addon-example/blob/8dc7c6e/README.md [example-issue]: https://github.com/hassio-addons/addon-example/issues -[example-version-shield]: https://img.shields.io/badge/version-61f89b2-blue.svg +[example-version-shield]: https://img.shields.io/badge/version-8dc7c6e-blue.svg [example-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/example-armhf.svg [example-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [example-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/example/CHANGELOG.md b/example/CHANGELOG.md index f0ccc0bbf..fe42295b6 100644 --- a/example/CHANGELOG.md +++ b/example/CHANGELOG.md @@ -1,32 +1,35 @@ # Changelog since v1.2.0 -2018/05/10 13:20 UTC - [61f89b2](https://github.com/hassio-addons/addon-example/commit/61f89b2b1366d766de2ee3218cb47e55931fe30a) by [@frenck](https://github.com/frenck) +2018/05/10 14:03 UTC - [8dc7c6e](https://github.com/hassio-addons/addon-example/commit/8dc7c6eb7453143429bf5f8c5bc69a9c535bb00a) by [@frenck](https://github.com/frenck) +> :sparkles: Adds initial add-on README template + +2018/05/10 14:03 UTC - [61f89b2](https://github.com/hassio-addons/addon-example/commit/61f89b2b1366d766de2ee3218cb47e55931fe30a) by [@frenck](https://github.com/frenck) > :ambulance: Fixes incorrect architectures in GitLab CI deployments -2018/05/10 13:20 UTC - [82a1d12](https://github.com/hassio-addons/addon-example/commit/82a1d120b4c57c6c6852092e555ceeaa88e2c4d7) by [@frenck](https://github.com/frenck) +2018/05/10 14:03 UTC - [82a1d12](https://github.com/hassio-addons/addon-example/commit/82a1d120b4c57c6c6852092e555ceeaa88e2c4d7) by [@frenck](https://github.com/frenck) > :rocket: Adds GitLab CI -2018/05/10 13:20 UTC - [754e99a](https://github.com/hassio-addons/addon-example/commit/754e99a0384827e76dfd95f5c01eef3ce5bea153) by [@frenck](https://github.com/frenck) +2018/05/10 14:03 UTC - [754e99a](https://github.com/hassio-addons/addon-example/commit/754e99a0384827e76dfd95f5c01eef3ce5bea153) by [@frenck](https://github.com/frenck) > :books: Updates README -2018/05/10 13:20 UTC - [04fd3b3](https://github.com/hassio-addons/addon-example/commit/04fd3b3a1a1b7cbd0052cf850ac409263e38bed0) by [@frenck](https://github.com/frenck) +2018/05/10 14:03 UTC - [04fd3b3](https://github.com/hassio-addons/addon-example/commit/04fd3b3a1a1b7cbd0052cf850ac409263e38bed0) by [@frenck](https://github.com/frenck) > :sparkles: Adds Probot configuration -2018/05/10 13:20 UTC - [a8eb230](https://github.com/hassio-addons/addon-example/commit/a8eb23052da29a98495c9ae03dad910880a072ca) by [@frenck](https://github.com/frenck) +2018/05/10 14:03 UTC - [a8eb230](https://github.com/hassio-addons/addon-example/commit/a8eb23052da29a98495c9ae03dad910880a072ca) by [@frenck](https://github.com/frenck) > :shirt: Fixes Markdownlint warning in License -2018/05/10 13:20 UTC - [9e23436](https://github.com/hassio-addons/addon-example/commit/9e23436cf0eddbf260e35464397f6afa8309e520) by [@frenck](https://github.com/frenck) +2018/05/10 14:03 UTC - [9e23436](https://github.com/hassio-addons/addon-example/commit/9e23436cf0eddbf260e35464397f6afa8309e520) by [@frenck](https://github.com/frenck) > :sparkles: Adds .yamllint configuration -2018/05/10 13:20 UTC - [d68c302](https://github.com/hassio-addons/addon-example/commit/d68c302ee83e072ad617af71dfdc2b3350afe826) by [@frenck](https://github.com/frenck) +2018/05/10 14:03 UTC - [d68c302](https://github.com/hassio-addons/addon-example/commit/d68c302ee83e072ad617af71dfdc2b3350afe826) by [@frenck](https://github.com/frenck) > :fire: Removes CircleCI -2018/05/10 13:20 UTC - [5a218da](https://github.com/hassio-addons/addon-example/commit/5a218dafa2c868aeb97678acf08446a25e6c3874) by [@frenck](https://github.com/frenck) +2018/05/10 14:03 UTC - [5a218da](https://github.com/hassio-addons/addon-example/commit/5a218dafa2c868aeb97678acf08446a25e6c3874) by [@frenck](https://github.com/frenck) > :shirt: Fixes hadolint warnings -2018/05/10 13:20 UTC - [81cffdf](https://github.com/hassio-addons/addon-example/commit/81cffdfa36121fe24146cbc8cd6ad74dc21348d0) by [@frenck](https://github.com/frenck) +2018/05/10 14:03 UTC - [81cffdf](https://github.com/hassio-addons/addon-example/commit/81cffdfa36121fe24146cbc8cd6ad74dc21348d0) by [@frenck](https://github.com/frenck) > :books: Replaces Changelog with GitHub releases -2018/05/10 13:20 UTC - [ca4bd1b](https://github.com/hassio-addons/addon-example/commit/ca4bd1b5005f51f0e07cd192a9f1bb20cd9ded81) by [@frenck](https://github.com/frenck) +2018/05/10 14:03 UTC - [ca4bd1b](https://github.com/hassio-addons/addon-example/commit/ca4bd1b5005f51f0e07cd192a9f1bb20cd9ded81) by [@frenck](https://github.com/frenck) > :fire: Removes CodeClimate diff --git a/example/README.md b/example/README.md new file mode 100644 index 000000000..5a5baa6ea --- /dev/null +++ b/example/README.md @@ -0,0 +1,62 @@ +# 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] + +Example add-on by Community Hass.io add-ons. + +## 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: + + + +## 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] + +[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://community.home-assistant.io?u=frenck +[discord-shield]: https://img.shields.io/discord/330944238910963714.svg +[discord]: https://discord.gg/c5DvZ4e +[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg +[release-shield]: https://img.shields.io/badge/version-8dc7c6e-blue.svg +[release]: https://github.com/hassio-addons/addon-example/tree/8dc7c6e +[docs]: https://github.com/hassio-addons/addon-example/blob/8dc7c6e/README.md +[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg +[buymeacoffee]: https://www.buymeacoffee.com/frenck \ No newline at end of file diff --git a/example/config.json b/example/config.json index dd3d9095c..804930884 100644 --- a/example/config.json +++ b/example/config.json @@ -1,6 +1,6 @@ { "name": "Example", - "version": "61f89b2", + "version": "8dc7c6e", "slug": "example", "description": "Example add-on by Community Hass.io Add-ons", "url": "https://github.com/hassio-addons/addon-example",