From 8ef2a14d0ef3b6ee2387e7d8f6179bfd7f719c54 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 21 Jan 2021 23:33:23 +0100 Subject: [PATCH] Documentation tweaks --- README.md | 10 +++++----- traccar/.README.j2 | 2 +- traccar/DOCS.md | 6 ++---- 3 files changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 84f97fd..9dac446 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] @@ -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-traccar.svg -[commits]: https://github.com/hassio-addons/addon-traccar/commits/master +[commits]: https://github.com/hassio-addons/addon-traccar/commits/main [contributors]: https://github.com/hassio-addons/addon-traccar/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-traccar/blob/master/traccar/DOCS.md +[docs]: https://github.com/hassio-addons/addon-traccar/blob/main/traccar/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-traccar/81407?u=frenck [frenck]: https://github.com/frenck +[github-actions-shield]: https://github.com/hassio-addons/addon-traccar/workflows/CI/badge.svg +[github-actions]: https://github.com/hassio-addons/addon-traccar/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-traccar/badges/master/pipeline.svg -[gitlabci]: https://gitlab.com/hassio-addons/addon-traccar/pipelines [i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [issue]: https://github.com/hassio-addons/addon-traccar/issues [license-shield]: https://img.shields.io/github/license/hassio-addons/addon-traccar.svg diff --git a/traccar/.README.j2 b/traccar/.README.j2 index 9154474..3cca6ba 100644 --- a/traccar/.README.j2 +++ b/traccar/.README.j2 @@ -80,5 +80,5 @@ If you are more interested in stable releases of our add-ons: [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg [release-shield]: https://img.shields.io/badge/version-{{ version }}-blue.svg [release]: {{ repo }}/tree/{{ version }} -[screenshot]: https://github.com/hassio-addons/addon-traccar/raw/master/images/screenshot.png +[screenshot]: https://github.com/hassio-addons/addon-traccar/raw/main/images/screenshot.png [traccar]: https://www.traccar.org diff --git a/traccar/DOCS.md b/traccar/DOCS.md index 5c6ee1d..19b6b87 100644 --- a/traccar/DOCS.md +++ b/traccar/DOCS.md @@ -106,7 +106,7 @@ to your `/config/traccar.xml` file. A list if all entries can be found here: - + To find out which protocol your device uses, please refer to the Traccar website: @@ -114,8 +114,7 @@ website: ## 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 @@ -177,7 +176,6 @@ SOFTWARE. [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-traccar/81407?u=frenck [frenck]: https://github.com/frenck [issue]: https://github.com/hassio-addons/addon-traccar/issues -[keepchangelog]: http://keepachangelog.com/en/1.0.0/ [reddit]: https://reddit.com/r/homeassistant [releases]: https://github.com/hassio-addons/addon-traccar/releases [semver]: http://semver.org/spec/v2.0.0.htm