From f6b996605d7846e484046b03c671b562d98e381f Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 22 Jan 2021 10:30:38 +0100 Subject: [PATCH] Documentation tweaks --- README.md | 10 +++++----- wireguard/DOCS.md | 4 +--- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5f95bc9..c3888af 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ ![Supports amd64 Architecture][amd64-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] @@ -111,19 +111,19 @@ SOFTWARE. [armhf-shield]: https://img.shields.io/badge/armhf-yes-green.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-wireguard.svg -[commits]: https://github.com/hassio-addons/addon-wireguard/commits/master +[commits]: https://github.com/hassio-addons/addon-wireguard/commits/main [contributors]: https://github.com/hassio-addons/addon-wireguard/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-wireguard/blob/master/wireguard/DOCS.md +[docs]: https://github.com/hassio-addons/addon-wireguard/blob/main/wireguard/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-wireguard/134662?u=frenck [frenck]: https://github.com/frenck +[github-actions-shield]: https://github.com/hassio-addons/addon-wireguard/workflows/CI/badge.svg +[github-actions]: https://github.com/hassio-addons/addon-wireguard/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-wireguard/badges/master/pipeline.svg -[gitlabci]: https://gitlab.com/hassio-addons/addon-wireguard/pipelines [i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [issue]: https://github.com/hassio-addons/addon-wireguard/issues [license-shield]: https://img.shields.io/github/license/hassio-addons/addon-wireguard.svg diff --git a/wireguard/DOCS.md b/wireguard/DOCS.md index 5aece9a..936cfc1 100644 --- a/wireguard/DOCS.md +++ b/wireguard/DOCS.md @@ -464,8 +464,7 @@ If you have, sharing would be appreciated! ## 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 @@ -529,7 +528,6 @@ SOFTWARE. [frenck]: https://github.com/frenck [ha-rest]: https://www.home-assistant.io/components/rest/ [issue]: https://github.com/hassio-addons/addon-wireguard/issues -[keepchangelog]: http://keepachangelog.com/en/1.0.0/ [reddit]: https://reddit.com/r/homeassistant [releases]: https://github.com/hassio-addons/addon-wireguard/releases [semver]: http://semver.org/spec/v2.0.0.htm