Skip to content

Commit 613be7b

Browse files
committed
Update README
1 parent b356590 commit 613be7b

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
<p align="center">
22
<img src="gopher.png">
33
</p>
4-
5-
![Go](https://img.shields.io/github/workflow/status/globocom/go-buffer/Go?style=flat-square)
6-
[![License](https://img.shields.io/github/license/globocom/go-buffer?color=blue&style=flat-square)](https://github.com/globocom/go-buffer/blob/master/LICENSE)
7-
![Go](https://img.shields.io/github/go-mod/go-version/globocom/go-buffer?style=flat-square)
8-
[![PkgGoDev](https://img.shields.io/badge/Go-reference-blue?style=flat-square)](https://pkg.go.dev/github.com/globocom/go-buffer)
4+
<p align="center">
5+
<img src="https://img.shields.io/github/workflow/status/globocom/go-buffer/Go?style=flat-square">
6+
<a href="https://github.com/globocom/go-buffer/blob/master/LICENSE">
7+
<img src="https://img.shields.io/github/license/globocom/go-buffer?color=blue&style=flat-square">
8+
</a>
9+
<img src="https://img.shields.io/github/go-mod/go-version/globocom/go-buffer?style=flat-square">
10+
<a href="https://pkg.go.dev/github.com/globocom/go-buffer">
11+
<img src="https://img.shields.io/badge/Go-reference-blue?style=flat-square">
12+
</a>
13+
</p>
914

1015
# go-buffer
1116

@@ -17,7 +22,7 @@
1722

1823
## Examples
1924

20-
### Size-based flush
25+
### Size-triggered flush
2126

2227
```golang
2328
package main
@@ -39,6 +44,7 @@ func main() {
3944
}
4045
}),
4146
)
47+
// ensure the buffer
4248
defer buff.Close()
4349

4450
buff.Push("item 1")
@@ -54,7 +60,7 @@ func main() {
5460
}
5561
```
5662

57-
### Interval-based flush
63+
### Interval-triggered flush
5864

5965
```golang
6066
package main

0 commit comments

Comments
 (0)