converted readme to markdown

README

@@ -1,40 +0,0 @@
-Couchrest is a loose port of the couch.js library from CouchDB’s Futon admin interface, which I find to be concise, clear, and well designed.
-
-I prefer to stay close to the metal, especially when the metal is as clean and simple as CouchDB’s HTTP API. The main thing Couchrest does for you is manage the Ruby <=> JSON serialization, and point your actions (database creation, document CRUD, view creation and queries, etc) at the appropriate API endpoints.
-
-The core of Couchrest is Heroku’s excellent REST Client Ruby HTTP wrapper. REST Client takes all the nastyness of Net::HTTP and gives is a pretty face, while still giving you more control than Open-URI. I recommend it anytime you’re interfacing with a well-defined API. (We use it for Grabb.it’s Tumblr integration, and it works like a charm.)
-
-The most complete source of documentation are the spec files. To ensure that your environment is setup for successful CouchRest operation, from the project root directory run `autotest` or `spec spec` (requires RSpec and optionally ZenTest for autotest support). 
-
-Quick Start:
-
-@cr = CouchRest.new("http://localhost:5984")
-@db = @cr.create_db('couchrest-test')
-response = @db.save({:key => 'value', 'another key' => 'another value'})
-doc = @db.get(response['id'])
-puts doc.inspect
-
-Please note that @cr.database('a-db-name') does not go over the wire at all. So it won't raise an error if the database does not exist. If you need to ensure that a database exists, call: @cr.create_db(dbname) rescue nilkey
-
-Bulk Save:
-
-@db.bulk_save([
-    {"wild" => "and random"},
-    {"mild" => "yet local"},
-    {"another" => ["set","of","keys"]}
-  ])
-puts @db.documents.inspect # returns ids and revs of the current docs
-
-Creating and Querying Views:
-
-@db.save({
-  "_id" => "_design/first", 
-  :views => {
-    :test => {
-      :map => "function(doc){for(var w in doc){ if(!w.match(/^_/))emit(w,doc[w])}}"
-      }
-    }
-  })
-puts @db.view('first/test')['rows'].inspect 
-
-

README.markdown

@@ -0,0 +1,51 @@
+## CouchRest - CouchDB, close to the metal
+
+CouchRest is based on [CouchDB's couch.js test library](http://svn.apache.org/repos/asf/incubator/couchdb/trunk/share/www/script/couch.js), which I find to be concise, clear, and well designed. CouchRest lightly wraps CouchDB's HTTP API, managing JSON serialization, and remembering the URI-paths to CouchDB's API endpoints so you don't have to.
+
+CouchRest's lighweight is designed to make a simple base for application and framework-specific object oriented APIs.
+
+### Easy Install
+
+`sudo gem install jchris-couchdb -s http://gems.github.com`
+
+### Relax, it's RESTful
+
+The core of Couchrest is Heroku’s excellent REST Client Ruby HTTP wrapper. REST Client takes all the nastyness of Net::HTTP and gives is a pretty face, while still giving you more control than Open-URI. I recommend it anytime you’re interfacing with a well-defined web service. 
+
+### Running the Specs
+
+The most complete documentation is the spec/ directory. To validate your CouchRest install, from the project root directory run `rake`, or `autotest` (requires RSpec and optionally ZenTest for autotest support). 
+
+### Examples
+
+Quick Start:
+
+    # with !, it creates the database if it doesn't already exist
+    @db = CouchRest.database!("http://localhost:5984/couchrest-test")
+    response = @db.save({:key => 'value', 'another key' => 'another value'})
+    doc = @db.get(response['id'])
+    puts doc.inspect
+
+Bulk Save:
+
+    @db.bulk_save([
+        {"wild" => "and random"},
+        {"mild" => "yet local"},
+        {"another" => ["set","of","keys"]}
+      ])
+    # returns ids and revs of the current docs
+    puts @db.documents.inspect 
+
+Creating and Querying Views:
+
+    @db.save({
+      "_id" => "_design/first", 
+      :views => {
+        :test => {
+          :map => "function(doc){for(var w in doc){ if(!w.match(/^_/))emit(w,doc[w])}}"
+          }
+        }
+      })
+    puts @db.view('first/test')['rows'].inspect 
+
+