Permalink
Browse files

change readme to rdoc

  • Loading branch information...
ryanking committed Jan 25, 2010
1 parent 7a28cfa commit df8c76f96eb5acf1f168f4a96554d7a7e654d163
Showing with 12 additions and 13 deletions.
  1. +12 −13 README.mkd → README.rdoc
View
@@ -1,20 +1,20 @@
-# cassandra
+= cassandra
A Ruby client for the Cassandra distributed database.
-## License
+== License
Copyright 2009 Twitter, Inc. See included LICENSE file. Portions copyright 2004-2009 David Heinemeier Hansson, and used with permission.
-## Features
+== Features
* clean encapsulation of the Thrift API
* compatible UUID and Long classes, for GUID generation
* Ruby 1.9 compatibility
-The Github source repository is [here](http://github.com/fauna/cassandra/). Patches and contributions are very welcome.
+The Github source repository is {here}[http://github.com/fauna/cassandra/]. Patches and contributions are very welcome.
-## Installation
+== Installation
You need Ruby 1.8 or 1.9. If you have those, just run:
@@ -28,7 +28,7 @@ A server will be installed in `$HOME/cassandra/server`, and started in debug mod
WARNING: Don't use the test folder for your data, as it will get overwritten when you update the gem.
-## Usage
+== Usage
Now, start IRb and require the library:
@@ -54,19 +54,18 @@ The returned result will always be a Cassandra::OrderedHash.
See Cassandra for more methods.
-## Configuration
+== Configuration
By default, cassandra is setup to listen on localhost. If you want to move your clients to another host, you're going to need to change which interface it binds to in the storage-conf.xml. You should also change the seed address.
-## Node Auto-Discovery
+== Node Auto-Discovery
The list of hosts you pass to the client is only used to auto-discover all the nodes in your cluster. You don't need to give the client a list of all of your nodes.
-## Further reading
+== Further reading
-* [Up and Running With Cassandra](http://blog.evanweaver.com/articles/2009/07/06/up-and-running-with-cassandra)
+* {Up and Running With Cassandra}[http://blog.evanweaver.com/articles/2009/07/06/up-and-running-with-cassandra]
-## Reporting problems
-
-The Github issue tracker is [here](http://github.com/fauna/cassandra/issues). If you have problems with this library or Cassandra itself, please use the [cassandra-user mailing list](http://mail-archives.apache.org/mod_mbox/incubator-cassandra-user/).
+== Reporting problems
+The Github issue tracker is {here}[http://github.com/fauna/cassandra/issues]. If you have problems with this library or Cassandra itself, please use the {cassandra-user mailing list}[http://mail-archives.apache.org/mod_mbox/incubator-cassandra-user/].

0 comments on commit df8c76f

Please sign in to comment.