diff --git a/README.md b/README.md index 1da4bdf..78215ee 100644 --- a/README.md +++ b/README.md @@ -32,3 +32,36 @@ BenchmarkPretty/all-8 285554 3726 ns/op ``` To run the benchmarks yourself, simply clone this repo and run `go test -bench=.`. Keep in mind that they will be different, depending on what your computer's specs are. + +### Example + +```go +package main + +import ( + "strconv" + "os" + + "go.arsenm.dev/logger/log" + "go.arsenm.dev/logger" +) + +func init() { + // Default logger is JSONLogger going to stderr + log.Logger = logger.NewPretty(os.Stdout) +} + +func main() { + s := "hello" + i, err := strconv.Atoi(s) + if err != nil { + log.Error("Couldn't convert to integer"). + Str("input", s). + Err(err). + Send() + } + log.Info("Converted to integer"). + Int("output", i). + Send() +} +``` diff --git a/log/log.go b/log/log.go index a7c89d8..c8d415a 100644 --- a/log/log.go +++ b/log/log.go @@ -1,7 +1,7 @@ package log import ( - "logger" + "go.arsenm.dev/logger" "os" )