Skip to content

Commit 91bfaf2

Browse files
authored
Merge pull request #1 from floatdrop/update-readme
Update readme
1 parent 49837bd commit 91bfaf2

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55
[![Go Reference](https://pkg.go.dev/badge/github.com/floatdrop/batchan.svg)](https://pkg.go.dev/github.com/floatdrop/batchan)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
77

8+
A lightweight Go library for batching values from a channel with support for size-based and optional timeout-based flushing.
9+
10+
## Features
11+
12+
- Batch items from a channel based on size
13+
- Flush batches after a timeout, even if not full
14+
- Zero-dependency, idiomatic Go
15+
816
## Installation
917

1018
```bash
@@ -45,6 +53,10 @@ func main() {
4553
}
4654
```
4755

56+
## Contributing
57+
58+
Contributions are welcome! Please feel free to submit a Pull Request.
59+
4860
## License
4961

5062
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)