Skip to content

Commit 8eaa333

Browse files
committed
readme updates
1 parent 59e4a9d commit 8eaa333

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
[![Go Reference](https://pkg.go.dev/badge/github.com/klev-dev/klevdb.svg)](https://pkg.go.dev/github.com/klev-dev/klevdb)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
66

7-
klevdb is a fast message store, written in Go. Think single partition on kafka, but stored locally.
7+
klevdb is a fast message store, written in Go. Think single partition on Kafka, but stored locally.
88

9-
In addition to basic consuming by offset, you can also configure klevdb to index times and keys. Times index allow you to quickly find a message by its time (or the first message after a certain time). Keys index allow you to quickly find the last message with a given key.
9+
In addition to basic consuming by offset, you can also configure klevdb to index times and keys. Time indexes allow you to quickly find a message by its time (or the first message after a certain time). Key indexes allow you to quickly find the last message with a given key.
1010

1111
## Usage
1212

@@ -22,6 +22,8 @@ To use klevdb:
2222
package main
2323
2424
import (
25+
"fmt"
26+
2527
"github.com/klev-dev/klevdb"
2628
)
2729
@@ -93,7 +95,7 @@ ok github.com/klev-dev/klevdb 12.433s
9395
With default rollover of 1MB, for messages with keys 10B and values 128B:
9496
* ~300,000 writes/sec, no indexes
9597
* ~250,000 writes/sec, with all indexes enabled
96-
* scales lineary with the batch size
98+
* scales linearly with the batch size
9799

98100
### Consume
99101
```

0 commit comments

Comments
 (0)