From d164023113af58d370973b708648d1e3c1ccfbf7 Mon Sep 17 00:00:00 2001 From: Chris Date: Fri, 7 Jan 2022 15:12:01 +0100 Subject: [PATCH] Add badges to readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 01187e9..c36a41f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,16 @@ # go-bootstrap + +[![Build](https://img.shields.io/github/workflow/status/vshn/go-bootstrap/Test)][build] +![Go version](https://img.shields.io/github/go-mod/go-version/vshn/go-bootstrap) +[![Version](https://img.shields.io/github/v/release/vshn/go-bootstrap)][releases] +[![Maintainability](https://img.shields.io/codeclimate/maintainability/vshn/go-bootstrap)][codeclimate] +[![Coverage](https://img.shields.io/codeclimate/coverage/vshn/go-bootstrap)][codeclimate] +[![GitHub downloads](https://img.shields.io/github/downloads/vshn/go-bootstrap/total)][releases] + +[build]: https://github.com/vshn/go-bootstrap/actions?query=workflow%3ATest +[releases]: https://github.com/vshn/go-bootstrap/releases +[codeclimate]: https://codeclimate.com/github/vshn/go-bootstrap + Template repository for common Go setups ## Features @@ -50,7 +62,7 @@ TIP: You can search for these tasks using `grep -n -r "TODO:" .` 1. `docs/modules/pages/index.adoc`: Edit start page. 1. `docs/modules/nav.adoc`: Edit navigation. 1. `main.go`: Adjust variables. -1. Edit this README +1. Edit this README (including badges links) 1. Start hacking in `example_command.go`. After completing a task, you can remove the comment in the files.