Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
qichengzx committed Dec 12, 2021
1 parent ed74043 commit 729e63e
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Bitcask
----

Bitcask is a log-structured fast KV store.

This project is an implementation of Bitcask written in Go.

[Bitcask intro here](https://riak.com/assets/bitcask-intro.pdf)

## Example

```go
package main

import (
"github.com/qichengzx/bitcask"
"log"
)

func main() {
d, err := bitcask.New("your/path/here")
if err != nil {
log.Fatal(err)
}
defer d.Close()

d.Put([]byte("bitcask"), []byte("bitcask is a log-structured fast KV store"))
v, _ := d.Get([]byte("bitcask"))
log.Println(string(v))
}
```

0 comments on commit 729e63e

Please sign in to comment.