clean upmastermob
authorry dahl <[email protected]>
Fri, 28 Dec 2007 01:19:10 +0000 (27 17:19 -0800)
committerry dahl <[email protected]>
Fri, 28 Dec 2007 01:19:10 +0000 (27 17:19 -0800)
README
lib/response.rb [deleted file]
lib/view.rb

diff --git a/README b/README
index 751fb8d..0cf8ef9 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,17 @@
+This is a ruby language interface to CouchDB. It attempts to abstract all
+features of the protocol so that the user doesn't need to know anything about
+the REST interface.
+
+Documentation is currently non-existant but interested users/hackers can
+examine test.rb for examples of usage. 
+
 Author: Ryan Dahl [email protected]
-Released under same license as Ruby
+Copyright 2007 Ryan Dahl
+Released under same license as the Ruby language.
 
 TODO
 - Wrap the response from @connection.request in a new class
   Automatically raise errors based on the status code or the content
   of the JSON response. 
+- CouchDB::View is buggy and needs more work.
+- Documentation
diff --git a/lib/response.rb b/lib/response.rb
deleted file mode 100644 (file)
index e04fbaa..0000000
+++ /dev/null
@@ -1,7 +0,0 @@
-module CouchDB
-  class Response
-    def initialize(raw)
-      @raw = raw
-    end 
-  end
-end
\ No newline at end of file
index 7bf7775..c942128 100644 (file)
@@ -1,4 +1,6 @@
 module CouchDB
+  # CouchDB::View is not a true CouchDB::Document, but has a similar
+  # interface. The most important method is find.
   class View
     
     def initialize(database, overview_name, name, _source=nil)
@@ -61,4 +63,4 @@ module CouchDB
     end
   
   end
-end
\ No newline at end of file
+end