From 84de8300d6478118d617a7826aee172dc015a05a Mon Sep 17 00:00:00 2001 From: Jason Kulatunga Date: Fri, 5 Aug 2022 08:17:53 -0700 Subject: [PATCH] update readme. --- README.md | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 695b678..8abded8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ -# taggr -Create git tags without cloning repository +# Taggr + +

+ + portfolio_view + +

+ +Language agnostic tool to create Git Tag without cloning a repository. + +# Documentation +Full documentation is available at [PackagrIO/docs](https://github.com/PackagrIO/docs) + + +# Usage + +``` +cd /path/to/git/repo +cat pkg/version/version.go +# const VERSION = "0.0.3" + +# export PACKAGR_PACKAGE_TYPE=[major/minor/patch] +packagr-taggr create --scm github \ +--name analogj/golang_analogj_test \ +--sha ab1b5d4536a521c5797e749db34a281b9be5f68d \ +--tag v2.0.0 +``` + +# Inputs +- `scm` +- `scm_repo_full_name` +- `scm_repo_tag_name` +- `scm_repo_sha` + +# Logo + +- [chevron By Travis Avery, US ](https://thenounproject.com/travisavery/collection/ui-ux-circles-solid/?i=2453786) +