Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
roeldev committed Jan 1, 2021
1 parent 3863cf4 commit 49c5dab
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
errors
errors
======
[![Latest release][latest-release-img]][latest-release-url]
[![Build status][build-status-img]][build-status-url]
Expand All @@ -22,10 +22,12 @@
[doc-url]: https://pkg.go.dev/github.com/go-pogo/errors


Package `errors` implements functions to manipulate errors, record stack frames and apply basic formatting to errors. It
is inspired by `golang.org/x/xerrors` and is designed to be a drop in replacement for it, as well as the standard
library's `errors` package. The package contains additional functions, interfaces and structs for working with
goroutines, multiple errors and custom error types.
Package `errors` implements functions to manipulate errors, record stack frames
and apply basic formatting to errors. It is inspired by `golang.org/x/xerrors`
and is designed to be a drop in replacement for it, as well as the standard
library's `errors` package. The package contains additional functions,
interfaces and structs for working with goroutines, multiple errors and custom
error types.

```sh
go get github.com/go-pogo/errors
Expand All @@ -36,9 +38,9 @@ import "github.com/go-pogo/errors"
```

## Stack trace

Every error can track stack trace information. Just wrap it with `errors.Trace()` and an addition stack frame is
captured and stored within the error.
Every error can track stack trace information. Just wrap it
with `errors.Trace()` and an addition stack frame is captured and stored within
the error.

```text
some error: something happened:
Expand All @@ -49,15 +51,13 @@ some error: something happened:
```

## Documentation

Additional detailed documentation is available at [pkg.go.dev][doc-url]

## Created with

<a href="https://www.jetbrains.com/?from=go-pogo" target="_blank"><img src="https://pbs.twimg.com/profile_images/1206615658638856192/eiS7UWLo_400x400.jpg" width="35" /></a>

## License

Copyright © 2019-2021 [Roel Schut](https://roelschut.nl). All rights reserved.

This project is governed by a BSD-style license that can be found in the [LICENSE](LICENSE) file.
This project is governed by a BSD-style license that can be found in
the [LICENSE](LICENSE) file.

0 comments on commit 49c5dab

Please sign in to comment.