Skip to content
Snippets Groups Projects
Verified Commit ec88fe9e authored by BhEaN's avatar BhEaN :alien:
Browse files

docs(readme): improve documentation

parent 8951337f
1 merge request!1Initial development
Pipeline #2706 failed with stages
in 1 minute and 30 seconds
[![Pipelines](https://code.vandalsweb.com/vandalsweb/go-semver/badges/master/pipeline.svg)](https://code.vandalsweb.com/vandalsweb/go-semver.git/pipelines)
[![Pipelines](https://code.vandalsweb.com/vandalsweb/go-semver/badges/master/pipeline.svg)](https://code.vandalsweb.com/vandalsweb/go-semvers/pipelines)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
[![Go Report Card](https://goreportcard.com/badge/code.vandalsweb.com/vandalsweb/go-semver)](https://goreportcard.com/report/code.vandalsweb.com/vandalsweb/go-semver)
GO semver
===
Simple application to get the next version of a project based in tags and the conventional commits messages of git
Simple application to suggest the next version of a project (using the [semantic versioning](https://semver.org) specification) according
to the last commit messages writen in the [conventional commits](https://www.conventionalcommits.org) format.
Description
......@@ -82,11 +82,15 @@ the required binary to the `bin/` directory.
References
---
Tools, external libraries and other third-part software used in the project:
Tools, external libraries, useful references and other third-part software used in the project:
- [git-hooks](https://github.com/git-hooks/git-hooks): Hook manager.
- [git-chglog](https://github.com/git-hooks/git-hooks): CHANGELOG generator.
- [ShellCheck](https://github.com/koalaman/shellcheck): A shell script static analysis tool.
- [GoReleaser](https://goreleaser.com): GoReleaser is a release automation tool for Go projects.
- [Semantic Versioning (semver)](https://semver.org): A simple set of rules and requirements that dictate how version numbers are assigned and
incremented.
- [Conventional Commits](https://www.conventionalcommits.org): A specification for adding human and machine readable meaning to commit
messages.
License
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment