From 42c880f9048a0093704ea6da549f6698c9f92a3d Mon Sep 17 00:00:00 2001 From: Lukasz Raczylo Date: Sun, 9 May 2021 21:13:56 +0100 Subject: [PATCH] Update documentation with docker and supported architectures for binaries and images. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index d626e7f..8a3282d 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ Project created overnight, to prove that management of semantic versioning is NO - [Usage](#usage) - [As a binary](#as-a-binary) - [As a github action](#as-a-github-action) + - [As a docker container](#as-a-docker-container) - [Calculations example](#calculations-example) - [Example configuration](#example-configuration) - [Good to know](#good-to-know) @@ -23,6 +24,11 @@ Project created overnight, to prove that management of semantic versioning is NO #### As a binary +You can download latest versions of the binaries from the [release page](https://github.com/lukaszraczylo/semver-generator/releases/latest). + +**Supported OS and architectures:** +Darwin ARM64/AMD64, Linux ARM64/AMD64, Windows AMD64 + ```bash bash$ ./semver-gen generate -r https://github.com/nextapps-de/winbox SEMVER 9.0.10 @@ -43,9 +49,11 @@ Available Commands: Flags: -c, --config string Path to config file (default "config.yaml") + -d, --debug Enable debug mode -h, --help help for semver-gen -l, --local Use local repository -r, --repository string Remote repository URL. (default "https://github.com/lukaszraczylo/simple-gql-client") + -v, --version Display version ``` #### As a github action @@ -76,6 +84,15 @@ jobs: echo "Semantic version detected: ${{ steps.semver.outputs.semantic_version }}" ``` +#### As a docker container + +```bash +docker pull ghcr.io/lukaszraczylo/semver-generator:latest +``` + +**Docker supported architectures:** +Linux/arm64, Linux/amd64 + #### Calculations example * 0.0.1 - PATCH - starting commit