Skip to content
Browse files

Add readme

  • Loading branch information...
1 parent cbdcf76 commit be08886c5acc41d7843f5d929b83f4d6a1a1be09 @krestenkrab committed Apr 4, 2011
Showing with 17 additions and 0 deletions.
  1. +17 −0 README.md
View
17 README.md
@@ -0,0 +1,17 @@
+Welcome to BDB
+==============
+
+This package consists of two interesting modules
+
+* `bdb` which wraps Berkeley DB with operations for `insert`, `lookup`, etc.
+ Keys and values are binaries throughout this API.
+* `bets` (for Berkeley-ETS) is an ETS-like API which uses `bdb`; it uses `sext`
+ for encoding the key part of the tuples stored, so matching with `bets:select/2`
+ only scans relevant subsets accordingly.
+
+Underneath the covers, the module bdb_nifs has the low-level API that
+implements most of the Berkeley DB C-level API.
+
+
+BSB/BETS is Copyright (C) 2011 by Trifork, and released under The
+Apache License, Version 2.

0 comments on commit be08886

Please sign in to comment.
Something went wrong with that request. Please try again.