From 39f399bea641f711baaea0cd3f2004a1106cb0b8 Mon Sep 17 00:00:00 2001 From: Marvin Steadfast Date: Mon, 21 Jun 2021 10:06:12 +0200 Subject: [PATCH] fixes badges --- Makefile | 4 +++- README.md | 10 +++++----- don.go | 3 --- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/Makefile b/Makefile index 8acf0fd..13f9741 100644 --- a/Makefile +++ b/Makefile @@ -26,7 +26,9 @@ tidy: .PHONY: readme readme: goreadme \ - -title don \ + -import-path go.xsfx.dev/don \ + -badge-goreportcard \ + -badge-godoc \ -credit=false \ -functions \ -types \ diff --git a/README.md b/README.md index 6c215ce..991a371 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # don +[![GoDoc](https://img.shields.io/badge/pkg.go.dev-doc-blue)](http://pkg.go.dev/go.xsfx.dev/don) +[![Go Report Card](https://goreportcard.com/badge/go.xsfx.dev/don)](https://goreportcard.com/report/go.xsfx.dev/don) + Package don is a little helper if you need to check for the readiness of something. This could be a command to run (like ssh) or a `db.Ping()` for check of the readiness of a database container. -![Go Reference](https://pkg.go.dev/badge/go.xsfx.dev/don.svg) -![Build Status](https://ci.xsfx.dev/api/badges/xsteadfastx/don/status.svg) - ## Use as commandline tool Download the tool from the [download page](https://git.xsfx.dev/xsteadfastx/don/releases). @@ -60,14 +60,14 @@ if err := don.Ready( ## Functions -### func [Cmd](/don.go#L68) +### func [Cmd](/don.go#L65) `func Cmd(c string) func() bool` Cmd returns a `func() bool` for working with `don.Ready()`. It executes a command and returns a true if everything looks fine or a false if there was some kind of error. -### func [Ready](/don.go#L86) +### func [Ready](/don.go#L83) `func Ready(f func() bool, timeout time.Duration, retry time.Duration) error` diff --git a/don.go b/don.go index ecd4cc2..c002563 100644 --- a/don.go +++ b/don.go @@ -2,9 +2,6 @@ // This could be a command to run (like ssh) or a `db.Ping()` for check of the readiness // of a database container. // -// (image/Go Reference) https://pkg.go.dev/badge/go.xsfx.dev/don.svg -// (image/Build Status) https://ci.xsfx.dev/api/badges/xsteadfastx/don/status.svg -// // Use as commandline tool // // Download the tool from the (download page) https://git.xsfx.dev/xsteadfastx/don/releases.