Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update package URLs and add comments re: cdb format features

  • Loading branch information...
commit fd083dc4fcf094c7d477958c24b9fdc35c65ed35 1 parent 368f5e8
@jbarham jbarham authored
Showing with 12 additions and 6 deletions.
  1. +12 −6 README.md
View
18 README.md
@@ -1,6 +1,12 @@
-# cdb.go - By John Barham
+# go-cdb
-cdb.go is a [Go](http://golang.org/) package to read and write cdb ("constant database") files.
+go-cdb is a pure [Go](http://golang.org/) package to read and write cdb ("constant database") files.
+
+The cdb file format is a machine-independent format with the following features:
+
+ - *Fast lookups:* A successful lookup in a large database normally takes just two disk accesses. An unsuccessful lookup takes only one.
+ - *Low overhead:* A database uses 2048 bytes, plus 24 bytes per record, plus the space for keys and data.
+ - *No random limits:* cdb can handle any database up to 4 gigabytes. There are no other restrictions; records don't even have to fit into memory.
See the original cdb specification and C implementation by D. J. Bernstein
at http://cr.yp.to/cdb.html.
@@ -9,15 +15,15 @@ at http://cr.yp.to/cdb.html.
Assuming you have a working Go environment, installation is simply:
- go get github.com/jbarham/cdb.go
+ go get github.com/jbarham/go-cdb
The package documentation can be viewed online at
-http://gopkgdoc.appspot.com/pkg/github.com/jbarham/cdb.go
-or on the command line by running `go doc github.com/jbarham/cdb.go`.
+http://gopkgdoc.appspot.com/pkg/github.com/jbarham/go-cdb
+or on the command line by running `go doc github.com/jbarham/go-cdb`.
The included self-test program `cdb_test.go` illustrates usage of the package.
## Utilities
-The cdb.go package includes ports of the programs `cdbdump` and `cdbmake` from
+The go-cdb package includes ports of the programs `cdbdump` and `cdbmake` from
the [original implementation](http://cr.yp.to/cdb/cdbmake.html).
Please sign in to comment.
Something went wrong with that request. Please try again.