From bce3e667dff9d6ab51f4e37bc79ef961e36bfb31 Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Tue, 21 Jan 2014 14:37:55 -0700 Subject: Intermediate commit. --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index e26dc46..0309695 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,38 @@ bolt ==== +## Overview + A low-level key/value database for Go. + + +## API + +### DB + +### Creating a database + +``` +db := DB() +err := db.Open("/path/to/db", 0666) +... +err := db.Close() +``` + +### Creating a bucket + + +* Cursor + + +``` +DB +Bucket +Transaction / RWTransaction +Cursor / RWCursor + +page +meta +branchNode +leafNode +``` -- cgit v1.2.3