# HG changeset patch
# User Waqas Hussain <waqas20@gmail.com>
# Date 1278708756 -18000
# Node ID d3dd8fdcae1d9056aa4c5ec2ce13f97d05277ae9
# Parent  9add3ebe92f43eec9a75d12a1a0fa3d615378c21
mod_couchdb: Basic docs.

diff -r 9add3ebe92f4 -r d3dd8fdcae1d mod_couchdb.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_couchdb.wiki	Sat Jul 10 01:52:36 2010 +0500
@@ -0,0 +1,30 @@
+#summary A CouchDB backend for Prosody
+#labels Stage-Alpha
+
+= Introduction =
+
+This is an experimental Prosody backend for CouchDB.
+
+= Configuration =
+In your config file, in the global section add:
+{{{
+datastore = "couchdb";
+couchdb_url = "http://127.0.0.1:5984/database-name";
+}}}
+In your config file, in the modules_enabled list, add "storage" as the first module:
+{{{
+modules_enabled = {
+   "storage";
+   ...
+}
+}}}
+
+= Compatibility =
+
+Only works with trunk. As the trunk API is in flux, update this module as well when you update trunk.
+
+= Quirks =
+
+This implementation is a work in progress.
+
+ * The data stored in couchdb is limited to: account data, rosters, private XML and vCards