summaryrefslogtreecommitdiffstats
path: root/extra_plugins/task_localsearch/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'extra_plugins/task_localsearch/README.txt')
-rw-r--r--extra_plugins/task_localsearch/README.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/extra_plugins/task_localsearch/README.txt b/extra_plugins/task_localsearch/README.txt
new file mode 100644
index 0000000..f6f2d64
--- /dev/null
+++ b/extra_plugins/task_localsearch/README.txt
@@ -0,0 +1,12 @@
+This plugin implements a Tipue-based local search for your site.
+
+To use it, copy task_localsearch.plugin and task_localsearch
+into a plugins/ folder in your nikola site.
+
+After you build your site, you will have several new files in assets/css and assets/js
+and a search.html that you can use as a basis for using this in your site.
+
+For more information about how to customize it and use it, please refer to the tipue
+docs at http://www.tipue.com/search/
+
+Tipue is under an MIT license (see MIT-LICENSE.txt)