diff options
Diffstat (limited to 'vendor/github.com/hako/durafmt/README.md')
| -rw-r--r-- | vendor/github.com/hako/durafmt/README.md | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/vendor/github.com/hako/durafmt/README.md b/vendor/github.com/hako/durafmt/README.md new file mode 100644 index 000000000..128819282 --- /dev/null +++ b/vendor/github.com/hako/durafmt/README.md @@ -0,0 +1,80 @@ +# durafmt + +[](https://travis-ci.org/hako/durafmt) [](https://goreportcard.com/report/github.com/hako/durafmt) [](https://codecov.io/gh/hako/durafmt) [](https://godoc.org/github.com/hako/durafmt) +[](https://www.codetriage.com/hako/durafmt) + + + +durafmt is a tiny Go library that formats `time.Duration` strings into a human readable format. + +``` +go get github.com/hako/durafmt +``` + +# Why + +If you've worked with `time.Duration` in Go, you most likely have come across this: + +``` +53m28.587093086s // :) +``` + +The above seems very easy to read, unless your duration looks like this: + +``` +354h22m3.24s // :S +``` + +# Usage + +### durafmt.ParseString() + +```go +package main + +import ( + "fmt" + "github.com/hako/durafmt" +) + +func main() { + duration, err := durafmt.ParseString("354h22m3.24s") + if err != nil { + fmt.Println(err) + } + fmt.Println(duration) // 2 weeks 18 hours 22 minutes 3 seconds + // duration.String() // String representation. "2 weeks 18 hours 22 minutes 3 seconds" +} +``` + +### durafmt.Parse() + +```go +package main + +import ( + "fmt" + "time" + "github.com/hako/durafmt" +) + +func main() { + timeduration := (354 * time.Hour) + (22 * time.Minute) + (3 * time.Second) + duration := durafmt.Parse(timeduration).String() + fmt.Println(duration) // 2 weeks 18 hours 22 minutes 3 seconds +} +``` + +# Contributing + +Contributions are welcome! Fork this repo and add your changes and submit a PR. + +If you would like to fix a bug, add a feature or provide feedback you can do so in the issues section. + +You can run tests by runnning `go test`. Running `go test; go vet; golint` is recommended. + +durafmt is also tested against `gometalinter`. + +# License + +MIT
\ No newline at end of file |