Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yosssi committed Jun 18, 2014
1 parent ddeacd3 commit 084efaf
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
[![Coverage Status](https://coveralls.io/repos/yosssi/boltstore/badge.png?branch=HEAD)](https://coveralls.io/r/yosssi/boltstore)
[![GoDoc](https://godoc.org/github.com/yosssi/boltstore?status.png)](https://godoc.org/github.com/yosssi/boltstore)

## About
## Overview

BoltStore is a session store using [Bolt](https://github.com/boltdb/bolt). This store implements the [gorilla/sessions](https://github.com/gorilla/sessions) package's [Store](http://godoc.org/github.com/gorilla/sessions#Store) interface.
BoltStore is a session store using [Bolt](https://github.com/boltdb/bolt), which is a pure Go key/value store. You can store session data in Bolt by using this store. This store implements the [gorilla/sessions](https://github.com/gorilla/sessions) package's [Store](http://godoc.org/github.com/gorilla/sessions#Store) interface. BoltStore's APIs and examples can be seen on the BoltStore's [GoDoc](http://godoc.org/github.com/yosssi/boltstore) page.

## Installation

Expand All @@ -16,6 +16,8 @@ go get github.com/yosssi/boltstore/...

## Example

Here is a simple example using BoltStore. You can see other examples on the BoltStore's [GoDoc](http://godoc.org/github.com/yosssi/boltstore) page.

```go
package main

Expand Down Expand Up @@ -70,5 +72,15 @@ func main() {
}
```

## Benchmarks

```sh
BenchmarkNew 5000 316700 ns/op 19003 B/op 35 allocs/op
BenchmarkStore_Get 20000000 104 ns/op 0 B/op 0 allocs/op
BenchmarkStore_New 10000000 294 ns/op 130 B/op 2 allocs/op
BenchmarkStore_Save 5000 488683 ns/op 65484 B/op 136 allocs/op
BenchmarkStore_Save_delete 5000 476563 ns/op 59576 B/op 76 allocs/op
```

## Documentation
* [GoDoc](http://godoc.org/github.com/yosssi/boltstore)

0 comments on commit 084efaf

Please sign in to comment.