aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 12 insertions, 4 deletions
diff --git a/README b/README
index 1725196a6..236ce9da2 100644
--- a/README
+++ b/README
@@ -1,14 +1,22 @@
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
-Rename config.ini.sample to config.ini
-Edit config.ini to reflect your site
-Activate the plugin
+-------------
+ * Rename config.ini.sample to config.ini
+ * Edit config.ini to reflect your site
+ * Activate the plugin
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.
+standard.