Skip to content

Commit

Permalink
update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
AnalogJ committed Aug 5, 2022
1 parent 703ad63 commit 84de830
Showing 1 changed file with 38 additions and 2 deletions.
40 changes: 38 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,38 @@
# taggr
Create git tags without cloning repository
# Taggr

<p align="center">
<a href="https://github.com/PackagrIO/docs">
<img width="300" alt="portfolio_view" src="https://github.com/PackagrIO/bumpr/raw/master/images/bumpr.png">
</a>
</p>

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)

0 comments on commit 84de830

Please sign in to comment.