From f9c95bfce6ae34995abdd5efc09f92586b9923a3 Mon Sep 17 00:00:00 2001
From: Chris Anderson <jchris@grabb.it>
Date: Thu, 29 May 2008 12:46:46 -0700
Subject: [PATCH] Added a README

---
 README | 39 +++++++++++++++++++++++++++++++++++++++
 TODO   |  3 +++
 2 files changed, 42 insertions(+)
 create mode 100644 README
 create mode 100644 TODO

diff --git a/README b/README
new file mode 100644
index 0000000..0af22f5
--- /dev/null
+++ b/README
@@ -0,0 +1,39 @@
+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
+
+
+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 
+
+
diff --git a/TODO b/TODO
new file mode 100644
index 0000000..21135db
--- /dev/null
+++ b/TODO
@@ -0,0 +1,3 @@
+Gemspec
+Documentation
+Rakefile for running specs
\ No newline at end of file