From 9f85e531291a743d6072f57484b68bb0ab85ce1b Mon Sep 17 00:00:00 2001 From: Rick Barenthin Date: Mon, 25 Jul 2022 22:39:46 +0200 Subject: [PATCH] chore: add to the README simple usage instructions --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index a9f2d06..63d467b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # conventi [![Build Status](https://drone.riba-interactive.de/api/badges/rick/conventi/status.svg)](https://drone.riba-interactive.de/rick/conventi) + + +To initialize a git repositiory for version management and changelog generation use: + +``` +docker run -v "$(pwd):/conventi" registry.riba-interactive.de/conventi:lastest init +``` + +For updating the version and changelog simply run: +``` +docker run -v "$(pwd):/conventi" registry.riba-interactive.de/conventi:lastest +``` -- 2.45.2