From 45ed6a91a510d6c8b5ebca6ec6e749f9a2b9d351 Mon Sep 17 00:00:00 2001 From: Kyle Quest Date: Mon, 11 Sep 2017 11:16:11 -0700 Subject: [PATCH] badge info --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index c222cb9..46b87f8 100644 --- a/README.md +++ b/README.md @@ -108,9 +108,17 @@ Other assets to go along with your repository. ## Badges +* [Go Report Card](https://goreportcard.com/) - It will scan your code with `gofmt`, `go vet`, `gocyclo`, `golint`, `ineffassign`, `license` and `misspell`. Replace `github.com/golang-standards/project-layout` with your project reference. + +* [GoDoc](http://godoc.org) - It will provide online version of your GoDoc generated documentation. Change the link to point to your project. + +* Release - It will show the latest release number for your project. Change the github link to point to your project. + [![Go Report Card](https://goreportcard.com/badge/github.com/golang-standards/project-layout?style=flat-square)](https://goreportcard.com/report/github.com/golang-standards/project-layout) [![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](http://godoc.org/github.com/golang-standards/project-layout) [![Release](https://img.shields.io/github/release/golang-standards/project-layout.svg?style=flat-square)](https://github.com/golang-standards/project-layout/releases/latest) +## Notes +A more opinionated project template with sample/reusable configs, scripts and code is a WIP.