edualb/coverbadger

Generate coverage badge images for Markdown files using Go

coverbadger

Generate coverage badge images for Markdown files using Go

Getting Started

To install the executable (ensure your $PATH contains $GOPATH/bin):

go install github.com/obalunenko/coverbadger/cmd/coverbadger

Or download from relases

Quick Start:

---

Either enter a Markdown file that does not already exist, or a Markdown file (like your README.md) that you want to update with coverage badge info. After executing of `coverbadger` the following badge will be added

![coverbadger-tag-do-not-edit](<badge_url>)

This tag will be replaced by the image for your coverage badge.

---

To update a .md file badge (note: comma-separated): Manually set the coverage value (note: do not include %):

coverbadger -md="README.md,coverage.md" -coverage=95

Example:

Example of usage

Confused?

Try running:

coverbadger -h

Credits

@jpoles1 - as an author of original tool gopherbadger