Permalink
Browse files

Added a README.

Change-Id: I51bc1907d0cf57946263d6ea00ce7a539364b7a2
Reviewed-on: http://review.couchbase.org/7024
Tested-by: Dustin Sallings <dustin@spy.net>
Reviewed-by: Steve Yen <steve.yen@gmail.com>
  • Loading branch information...
1 parent 8d076cd commit beabb362896897d662982d1ef537f73ab9b1198a @dustin dustin committed with steveyen Jun 16, 2011
Showing with 17 additions and 0 deletions.
  1. +17 −0 README.markdown
View
@@ -0,0 +1,17 @@
+# mccouch
+
+No, not [this mccouch](https://github.com/mccouch), but a memcached
+binary protocol interface to [CouchDB][couchdb].
+
+This is used by Couchbase Server to provide an efficient means of
+moving data between from [ep-engine][epe] and [CouchDB][couchdb].
+
+If you want to build and hack on this, it is recommended to start with
+the [couchdb manifest build][manifest]. That'll get it all together
+for you.
+
+
+[couchdb]: http://couchdb.apache.org/
+[couchbase]: http://www.couchbase.com/
+[epe]: https://github.com/membase/ep-engine
+[manifest]: https://github.com/couchbase/couchdb-manifest

0 comments on commit beabb36

Please sign in to comment.