From a50cd11801083bf9d87b4397c10993ba569185f5 Mon Sep 17 00:00:00 2001 From: Tom Morelly Date: Thu, 29 Apr 2021 21:00:44 +0200 Subject: [PATCH] update readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 941530b..1d87c27 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A general purpose project template for golang CLI applications [![Test](https://github.com/FalcoSuessgott/golang-cli-template/actions/workflows/test.yml/badge.svg)](https://github.com/FalcoSuessgott/golang-cli-template/actions/workflows/test.yml) [![golangci-lint](https://github.com/FalcoSuessgott/golang-cli-template/actions/workflows/lint.yml/badge.svg)](https://github.com/FalcoSuessgott/golang-cli-template/actions/workflows/lint.yml) [![Go Report Card](https://goreportcard.com/badge/github.com/FalcoSuessgott/golang-cli-template)](https://goreportcard.com/report/github.com/FalcoSuessgott/golang-cli-template) [![Go Reference](https://pkg.go.dev/badge/github.com/FalcoSuessgott/golang-cli-template.svg)](https://pkg.go.dev/github.com/FalcoSuessgott/golang-cli-template) [![codecov](https://codecov.io/gh/FalcoSuessgott/golang-cli-template/branch/main/graph/badge.svg?token=Y5K4SID71F)](https://codecov.io/gh/FalcoSuessgott/golang-cli-template) -This template serves as a starting point for golang commandline applications based on the go community default [project-layout](https://github.com/golang-standards/project-layout). +This template serves as a starting point for golang commandline applications it is based on golang projects that I consider high quality and various other useful blog posts that helped me understanding golang better. # Features - [goreleaser](https://goreleaser.com/) with `deb.` and `.rpm` package releasing @@ -80,6 +80,10 @@ make fmt make fmtcheck ``` +## deps +```sh +make deps +``` ## build ```sh make build @@ -94,3 +98,11 @@ make test ```sh make cover ``` + +# Contribute +If you find issues in that setup or have some nice features / improvements, I would welcome an issue or a PR :) + + +# Ideas +- [ ] implement a `create` subcommand that preconfigures this project setup and all its dependencies +- [ ] introduce viper config examples