aboutsummaryrefslogtreecommitdiff
path: root/mod/opensearch/README
diff options
context:
space:
mode:
Diffstat (limited to 'mod/opensearch/README')
-rw-r--r--mod/opensearch/README21
1 files changed, 21 insertions, 0 deletions
diff --git a/mod/opensearch/README b/mod/opensearch/README
new file mode 100644
index 000000000..a25a00c93
--- /dev/null
+++ b/mod/opensearch/README
@@ -0,0 +1,21 @@
+OpenSearch endpoint for Elgg
+
+OVERVIEW
+-------------
+OpenSearch is a standard for exposing the data in your website for search
+to browsers and other web sites. For more information on this technology, visit
+the Wikipedia page on OpenSearch at http://en.wikipedia.org/wiki/OpenSearch
+
+INSTALL
+-------------
+ * Activate the plugin
+ * Edit OpenSearch settings in administration pages to reflect your site
+
+USAGE
+-------------
+Adds an OpenSearch description definition to the html head. Browsers
+will pick this up and allow you to add site specific search to your
+search bar.
+
+The plugin also provides an RSS 2.0 feed that conforms to the OpenSearch
+standard.