added README

jchris · Apr 22, 2009 · 2316837 · 2316837
1 parent 656d36f
commit 2316837
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+We have the hovercraft. It is fast and it skims just above the surface.
+
+There is much to be added to the hovercraft, but it already flies.
+
+## Welcome to Hovercraft
+
+An easy direct Erlang CouchDB library.
+
+Use this to abstract CouchDB behind a simple Erlang function call. Currently supports the database and document APIs, with views on the way.
+
+Released at #CouchHack '09
+Apache 2.0 License 
+copyright J. Chris Anderson
+
+contact: jchris@couch.io
diff --git a/hovercraft.erl b/hovercraft.erl
@@ -20,7 +20,7 @@
     delete_doc/2,
     start_attachment/3,
     next_attachment_bytes/1,
-    query_view/4 % not yet implemented
+    query_view/4 % coming soon
 ]).
 
 -include("../../couchdb/include/couch_db.hrl").