Skip to content

Commit

Permalink
Avoid using URLs, due to issue #1
Browse files Browse the repository at this point in the history
  • Loading branch information
dmjones committed Oct 14, 2018
1 parent a797334 commit a5f7119
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ those badges, just set the appropriate flags in the config file:


```
# Shows a godoc badge for your package (<a href="https://godoc.org">https://godoc.org</a>)
# Shows a godoc badge for your package
showGodocBadge = true
# Shows a Go report card for your package (<a href="https://goreportcard.com">https://goreportcard.com</a>)
# Shows a Go report card for your package
showGoReportBadge = false
```

Expand All @@ -37,8 +37,8 @@ For others, specify the markdown in the config file:

```
customMarkdownBadges = [
"[![Coverage Status](<a href="https://link/to/badge.svg">https://link/to/badge.svg</a>)](<a href="https://link/to/data">https://link/to/data</a>)",
"[![Build Status](<a href="https://link/to/badge.svg">https://link/to/badge.svg</a>)](<a href="https://link/to/data">https://link/to/data</a>)",
"[![Coverage Status](...)](...)",
"[![Build Status](...)](...)",
]
```

Expand Down
8 changes: 4 additions & 4 deletions docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,17 @@ in your package directory.
Some badges are supported directly by the tool (PRs welcome for others). For
those badges, just set the appropriate flags in the config file:
# Shows a godoc badge for your package (https://godoc.org)
# Shows a godoc badge for your package
showGodocBadge = true
# Shows a Go report card for your package (https://goreportcard.com)
# Shows a Go report card for your package
showGoReportBadge = false
For others, specify the markdown in the config file:
customMarkdownBadges = [
"[![Coverage Status](https://link/to/badge.svg)](https://link/to/data)",
"[![Build Status](https://link/to/badge.svg)](https://link/to/data)",
"[![Coverage Status](...)](...)",
"[![Build Status](...)](...)",
]
Additional markdown can be specified, which will be appended to the output from
Expand Down

0 comments on commit a5f7119

Please sign in to comment.