diff --git a/README.md b/README.md index cee0e93..e2f8310 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Home Assistant Add-On Repository for Cloudflared +# Home Assistant Add-on Repository for Cloudflared ![Project Stage][project-stage-shield] ![Maintenance][maintenance-shield] @@ -15,6 +15,10 @@ Additional add-ons might follow in the future. ## Installation +Adding this add-ons repository to your Home Assistant instance is +pretty straightforward. In the Home Assistant add-on store, +a possibility to add a repository is provided. + Use the following URL to add this repository: ```txt @@ -25,17 +29,39 @@ https://github.com/brenner-tobias/ha-addons ### ✓ [Cloudflared][addon-cloudflared] -![Latest Version][cloudflared-release-shield] +![Latest Version][cloudflared-version-shield] ![Supports armhf Architecture][cloudflared-armhf-shield] ![Supports armv7 Architecture][cloudflared-armv7-shield] ![Supports aarch64 Architecture][cloudflared-aarch64-shield] ![Supports amd64 Architecture][cloudflared-amd64-shield] ![Supports i386 Architecture][cloudflared-i386-shield] - +Use a Cloudflared tunnel (formerly Argo Tunnel) to remotely connect to Home Assistant without opening any ports [:books: Cloudflared add-on documentation][addon-doc-cloudflared] +## Releases + +Releases are based on [Semantic Versioning][semver], and use the format +of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +based on the following: + +- ``MAJOR``: Incompatible or major changes. +- ``MINOR``: Backwards-compatible new features and enhancements. +- ``PATCH``: Backwards-compatible bugfixes and package updates. + +## Support + +Got questions? + +Open an issue here on GitHub. Note, we use a separate +GitHub repository for each add-on. Please ensure you are creating the issue +on the correct GitHub repository matching the add-on. + +- [Open an issue for the add-on: Cloudflared][cloudflared-issue] + +For a general repository issue or add-on ideas [open an issue here][issue] + ## License MIT License @@ -60,14 +86,19 @@ 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. -[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared -[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/main/README.md +[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/tree/v0.2.5 +[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v0.2.5/README.md +[cloudflared-issue]: https://github.com/brenner-tobias/addon-cloudflared/issues +[cloudflared-version-shield]: https://img.shields.io/badge/version-v0.2.5-blue.svg [cloudflared-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [cloudflared-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [cloudflared-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [cloudflared-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [cloudflared-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[cloudflared-release-shield]: https://img.shields.io/github/v/release/brenner-tobias/addon-cloudflared?include_prereleases -[license-shield]: https://img.shields.io/github/license/brenner-tobias/ha-addons +[gitlabci-shield]: https://gitlab.com/brenner-tobias/ha-addons/badges/master/pipeline.svg +[gitlabci]: https://gitlab.com/brenner-tobias/ha-addons/pipelines +[issue]: https://github.com/brenner-tobias/ha-addons/issues +[license-shield]: https://img.shields.io/github/license/brenner-tobias/ha-addons.svg [maintenance-shield]: https://img.shields.io/maintenance/yes/2022.svg -[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg +[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg +[semver]: http://semver.org/spec/v2.0.0.html \ No newline at end of file