summaryrefslogtreecommitdiff
path: root/common/src/leap/soledad/common/ddocs/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'common/src/leap/soledad/common/ddocs/README.txt')
-rw-r--r--common/src/leap/soledad/common/ddocs/README.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/common/src/leap/soledad/common/ddocs/README.txt b/common/src/leap/soledad/common/ddocs/README.txt
index 37d89fbf..5569d929 100644
--- a/common/src/leap/soledad/common/ddocs/README.txt
+++ b/common/src/leap/soledad/common/ddocs/README.txt
@@ -1,3 +1,8 @@
+This directory holds a folder structure containing javascript files that
+represent the design documents needed by the CouchDB U1DB backend. These files
+are compiled into the `../ddocs.py` file by setuptools when creating the
+source distribution.
+
The following table depicts the U1DB CouchDB backend method and the URI that
is queried to obtain/update data from/to the server.