Skip to content

Commit 4504ef7

Browse files
authored
README: Add Features section (#73)
The package has an empty readme. Adding some basic highlights about why this is good makes sense.
1 parent 2fd451d commit 4504ef7

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,29 @@
22

33
`multierr` allows combining one or more Go `error`s together.
44

5+
## Features
6+
7+
- **Idiomatic**:
8+
multierr follows best practices in Go, and keeps your code idiomatic.
9+
- It keeps the underlying error type hidden,
10+
allowing you to deal in `error` values exclusively.
11+
- It provides APIs to safely append into an error from a `defer` statement.
12+
- **Performant**:
13+
multierr is optimized for performance:
14+
- It avoids allocations where possible.
15+
- It utilizes slice resizing semantics to optimize common cases
16+
like appending into the same error object from a loop.
17+
- **Interoperable**:
18+
multierr interoperates with the Go standard library's error APIs seamlessly:
19+
- The `errors.Is` and `errors.As` functions *just work*.
20+
- **Lightweight**:
21+
multierr comes with virtually no dependencies.
22+
523
## Installation
624

7-
go get -u go.uber.org/multierr
25+
```bash
26+
go get -u go.uber.org/multierr@latest
27+
```
828

929
## Status
1030

0 commit comments

Comments
 (0)