From 3728773f661e1d645fce1568b3bb8b9869e194e3 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 21 Jan 2021 22:28:04 +0100 Subject: [PATCH] Documentation tweaks --- README.md | 10 +++++----- airsonos/DOCS.md | 6 ++---- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9261b48..65d7afe 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ ![Supports armv7 Architecture][armv7-shield] ![Supports i386 Architecture][i386-shield] -[![GitLab CI][gitlabci-shield]][gitlabci] +[![Github Actions][github-actions-shield]][github-actions] ![Project Maintenance][maintenance-shield] [![GitHub Activity][commits-shield]][commits] @@ -106,19 +106,19 @@ SOFTWARE. [armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg [armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-airsonos.svg -[commits]: https://github.com/hassio-addons/addon-airsonos/commits/master +[commits]: https://github.com/hassio-addons/addon-airsonos/commits/main [contributors]: https://github.com/hassio-addons/addon-airsonos/graphs/contributors [discord-ha]: https://discord.gg/c5DvZ4e [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-airsonos/blob/master/airsonos/DOCS.md +[docs]: https://github.com/hassio-addons/addon-airsonos/blob/main/airsonos/DOCS.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-airsonos/36796?u=frenck [frenck]: https://github.com/frenck +[github-actions-shield]: https://github.com/hassio-addons/addon-airsonos/workflows/CI/badge.svg +[github-actions]: https://github.com/hassio-addons/addon-airsonos/actions [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png [github-sponsors]: https://github.com/sponsors/frenck -[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-airsonos/badges/master/pipeline.svg -[gitlabci]: https://gitlab.com/hassio-addons/addon-airsonos/pipelines [i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [issue]: https://github.com/hassio-addons/addon-airsonos/issues [license-shield]: https://img.shields.io/github/license/hassio-addons/addon-airsonos.svg diff --git a/airsonos/DOCS.md b/airsonos/DOCS.md index ccbbb34..6462cc0 100644 --- a/airsonos/DOCS.md +++ b/airsonos/DOCS.md @@ -177,8 +177,7 @@ separately. Every time it finds a new device, it will be added to that file. ## Changelog & Releases This repository keeps a change log using [GitHub's releases][releases] -functionality. The format of the log is based on -[Keep a Changelog][keepchangelog]. +functionality. Releases are based on [Semantic Versioning][semver], and use the format of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented @@ -234,14 +233,13 @@ 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. -[commits]: https://github.com/hassio-addons/addon-airsonos/commits/master +[commits]: https://github.com/hassio-addons/addon-airsonos/commits/main [contributors]: https://github.com/hassio-addons/addon-airsonos/graphs/contributors [discord-ha]: https://discord.gg/c5DvZ4e [discord]: https://discord.me/hassioaddons [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-airsonos/36796?u=frenck [frenck]: https://github.com/frenck [issue]: https://github.com/hassio-addons/addon-airsonos/issues -[keepchangelog]: http://keepachangelog.com/en/1.0.0/ [reddit]: https://reddit.com/r/homeassistant [releases]: https://github.com/hassio-addons/addon-airsonos/releases [semver]: http://semver.org/spec/v2.0.0.htm