xsteadfastx/don
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: adds badges
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Marvin Steadfast 2021-06-21 09:59:29 +02:00
parent 9fccb5e242
commit f10cdabc1c
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -4,6 +4,9 @@ Package don is a little helper if you need to check for the readiness of somethi
This could be a command to run (like ssh) or a `db.Ping()` for check of the readiness This could be a command to run (like ssh) or a `db.Ping()` for check of the readiness
of a database container. 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 ## Use as commandline tool
Download the tool from the [download page](https://git.xsfx.dev/xsteadfastx/don/releases). Download the tool from the [download page](https://git.xsfx.dev/xsteadfastx/don/releases).
@ -57,14 +60,14 @@ if err := don.Ready(
## Functions ## Functions
### func [Cmd](/don.go#L65) ### func [Cmd](/don.go#L68)
`func Cmd(c string) func() bool` `func Cmd(c string) func() bool`
Cmd returns a `func() bool` for working with `don.Ready()`. It executes a command and 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. returns a true if everything looks fine or a false if there was some kind of error.
### func [Ready](/don.go#L83) ### func [Ready](/don.go#L86)
`func Ready(f func() bool, timeout time.Duration, retry time.Duration) error` `func Ready(f func() bool, timeout time.Duration, retry time.Duration) error`

3
don.go
View File

@ -2,6 +2,9 @@
// This could be a command to run (like ssh) or a `db.Ping()` for check of the readiness // This could be a command to run (like ssh) or a `db.Ping()` for check of the readiness
// of a database container. // 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 // Use as commandline tool
// //
// Download the tool from the (download page) https://git.xsfx.dev/xsteadfastx/don/releases. // Download the tool from the (download page) https://git.xsfx.dev/xsteadfastx/don/releases.