Permalink
Browse files

updated readme

  • Loading branch information...
1 parent 22d5ef6 commit ecfe56ed3f7141beb485c04c4673d8bedd2a223a @ninjudd ninjudd committed Aug 13, 2009
Showing with 33 additions and 10 deletions.
  1. +1 −1 LICENSE
  2. +0 −9 README
  3. +32 −0 README.rdoc
View
@@ -1,4 +1,4 @@
-Copyright (c) 2008 Justin Balthrop
+Copyright (c) 2009 Justin Balthrop
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
View
9 README
@@ -1,9 +0,0 @@
-tuple
-=====
-
-Description goes here.
-
-COPYRIGHT
-=========
-
-Copyright (c) 2008 Justin Balthrop. See LICENSE for details.
View
@@ -0,0 +1,32 @@
+= Tuple
+
+Tuple provides fast, binary-sortable serialization for arrays of simple Ruby types. This
+means you do not have to deserialize your tuples to store them. This leads to significant
+performance benifits when using Tuples as keys for a BTree.
+
+A Tuple is just an Array of any number of simple Ruby types. The following types are
+supported (listed in ascending sort order):
+
+ * NilClass
+ * FalseClass
+ * Integer (Fixnum or Bignum)
+ * String
+ * Symbol
+ * True
+
+== Usage:
+
+ require 'tuple'
+
+ data = Tuple.dump([1, -43, :foo, "bar", true, false, nil])
+ => "\000\000\020\000\000\000\000\001..."
+ Tuple.load(data)
+ => [1, -43, :foo, "bar", true, false, nil]
+
+== Install:
+
+ sudo gem install ninjudd-tuple -s http://gems.github.com
+
+== License:
+
+Copyright (c) 2009 Justin Balthrop, Geni.com; Published under The MIT License, see LICENSE

0 comments on commit ecfe56e

Please sign in to comment.