aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
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
+```