From: Charles Connell <charles@connells.org>
Date: Fri, 3 Jan 2014 17:34:25 +0000 (-0500)
Subject: Document IndexDen dependency #237
X-Git-Tag: release-20150131~319
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=2d49aa5490660f8baeaf6c24fd066a575628d02f;p=oweals%2Fkarmaworld.git

Document IndexDen dependency #237
---

diff --git a/README.md b/README.md
index 7c592aa..23227b4 100644
--- a/README.md
+++ b/README.md
@@ -82,6 +82,18 @@ That workaround is repeated here. Make the following changes to
     location /assets/ {
         root /var/www/karmaworld/karmaworld/;
     }
+    
+### IndexDen
+KarmaNotes uses IndexDen to create a searchable index of all the notes
+in the system. Create an free IndexDen account at [their homepage](http://indexden.com/).
+You will be given a private URL that accesses your IndexDen account.
+Create a file at karmaworld/secret/indexden.py, and enter your private URL, and the name
+of the index you want KarmaNotes to use. The index will be created automatically when
+KarmaNotes is run if it doesn't already exist. For example,
+```
+PRIVATE_URL = 'http://:secretsecret@secret.api.indexden.com'
+INDEX = 'karmanotes_something_something'
+```
 
 ### Google Drive
 This software uses [Google Drive](https://developers.google.com/drive/) to