diff --git a/README.md b/README.md index b5565aca..1af6d7d6 100644 --- a/README.md +++ b/README.md @@ -311,10 +311,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/v1.2.0 -[addon-doc-example]: https://github.com/hassio-addons/addon-example/blob/v1.2.0/README.md +[addon-example]: https://github.com/hassio-addons/addon-example/tree/v1.3.0 +[addon-doc-example]: https://github.com/hassio-addons/addon-example/blob/v1.3.0/README.md [example-issue]: https://github.com/hassio-addons/addon-example/issues -[example-version-shield]: https://img.shields.io/badge/version-v1.2.0-blue.svg +[example-version-shield]: https://img.shields.io/badge/version-v1.3.0-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 new file mode 100644 index 00000000..2e2b18d2 --- /dev/null +++ b/example/CHANGELOG.md @@ -0,0 +1,27 @@ +[Full Changelog][changelog] + +### Added + +- Adds .yamllint configuration +- Adds Probot configuration +- Adds GitLab CI +- Adds add-on README template + +### Fixed + +- Fixes hadolint warnings +- Fixes Markdownlint warning in License + +### Changed + +- Updates README +- Upgrades add-on base image to v1.4.1 +- Updates wget to 1.19.5-r0 + +### Removed + +- Removes CodeClimate +- Replaces Changelog with GitHub releases +- Removes CircleCI + +[changelog]: https://github.com/hassio-addons/addon-example/compare/v1.2.0...v1.3.0 \ No newline at end of file diff --git a/example/README.md b/example/README.md index 6a4f08f2..24677020 100644 --- a/example/README.md +++ b/example/README.md @@ -1,7 +1,40 @@ # Community Hass.io Add-ons: Example -This is just a configuration stub to make the Hass.io repository work. +[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] -The add-on itself can be found at the following URL: +[![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. + +## 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-v1.3.0-blue.svg +[release]: https://github.com/hassio-addons/addon-example/tree/v1.3.0 +[docs]: https://github.com/hassio-addons/addon-example/blob/v1.3.0/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 809507cd..8ebdccd6 100644 --- a/example/config.json +++ b/example/config.json @@ -1,25 +1,25 @@ { "name": "Example", - "version": "1.2.0", + "version": "1.3.0", "slug": "example", "description": "Example add-on by Community Hass.io Add-ons", "url": "https://github.com/hassio-addons/addon-example", "startup": "application", "arch": [ - "aarch64", - "amd64", - "armhf", - "i386" + "aarch64", + "amd64", + "armhf", + "i386" ], "boot": "auto", "hassio_api": true, "options": { - "log_level": "info", - "seconds_between_quotes": 5 + "log_level": "info", + "seconds_between_quotes": 5 }, "schema": { - "log_level": "match(^(trace|debug|info|notice|warning|error|fatal)$)", - "seconds_between_quotes": "int(1,120)" + "log_level": "match(^(trace|debug|info|notice|warning|error|fatal)$)", + "seconds_between_quotes": "int(1,120)" }, "image": "hassioaddons/example-{arch}" -} +} \ No newline at end of file