aboutsummaryrefslogtreecommitdiff
path: root/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc.go b/doc.go
index caf66e9..b127f59 100644
--- a/doc.go
+++ b/doc.go
@@ -12,6 +12,9 @@ rolled back in the event of a crash.
The design of Bolt is based on Howard Chu's LMDB database project.
+Bolt currently works on Windows, Mac OS X, and Linux.
+
+
Basics
There are only a few types in Bolt: DB, Bucket, Tx, and Cursor. The DB is
@@ -33,7 +36,5 @@ values returned from Bolt cannot be changed. Writing to a read-only byte slice
will cause Go to panic. If you need to work with data returned from a Get() you
need to first copy it to a new byte slice.
-Bolt currently works on Mac OS and Linux. Windows support is coming soon.
-
*/
package bolt