Skip to content

Commit 7564cee

Browse files
committed
doc: readme - headings
1 parent 20ed61a commit 7564cee

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ If you want simple test assertions and feel like [testify](https://pkg.go.dev/gi
44

55
Highlights:
66

7-
- Minimal API: `Equal`, `Err`, and `True` assertions.
8-
- Correctly compares `time.Time` values and other types with an `Equal` method.
9-
- Flexible error assertions: check if an error exists, check its value, type, or any combination of these.
10-
- Zero hassle.
7+
- Minimal API: `Equal`, `Err`, and `True` assertions.
8+
- Correctly compares `time.Time` values and other types with an `Equal` method.
9+
- Flexible error assertions: check if an error exists, check its value, type, or any combination of these.
10+
- Zero hassle.
1111

1212
Be is new, but it's ready for production (or maybe I should say "testing" :) I've used it in three very different projects — a CLI tool, an API server, and a database engine — and it worked great every time.
1313

@@ -19,6 +19,8 @@ Install with go get:
1919
go get github.com/nalgeon/be
2020
```
2121

22+
### Equality
23+
2224
`Equal` asserts that two values are equal:
2325

2426
```go
@@ -47,6 +49,8 @@ func Test(t *testing.T) {
4749
}
4850
```
4951

52+
### Errors
53+
5054
`Err` asserts that there is an error:
5155

5256
```go
@@ -119,6 +123,8 @@ func Test(t *testing.T) {
119123
}
120124
```
121125

126+
### True/false
127+
122128
`True` asserts that an expression is true:
123129

124130
```go

0 commit comments

Comments
 (0)