Browse files

add readme

  • Loading branch information...
1 parent 3338778 commit ece0d8b3bb806e48a5f1f98717d7560b3bc3618b @jbhat jbhat committed Apr 24, 2012
Showing with 24 additions and 1 deletion.
  1. +24 −1 README.md
View
25 README.md
@@ -1 +1,24 @@
-WRITE ME
+## Overview
+
+Cassandra Queue is a cassandra-backed queue for storing time series data.
+
+## Table of contents
+
+1. [Installation](#section_1)
+1. [Authors](#section_2)
+1. [ License](#section_4)
+
+## <a name="section_1"></a>1 Installation
+
+It's as simple as gem install cassandra-queue! You will need a cassandra cluster for this to work.
+Cassandra Queue installs the cassandra client gem, which comes with a cassandra_helper binary, which can be used to start a local cassandra cluster.
+
+## <a name="section_2"></a>2 Authors
+
+Cassandra Queue was written by the following Ooyala engineer:
+
+* Jay Bhat ([jbhat](https://github.com/jbhat))
+
+## <a name="section_3"></a>3 License
+
+Cassandra Queue is released under [the MIT license](http://www.opensource.org/licenses/mit-license.php).

0 comments on commit ece0d8b

Please sign in to comment.