aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorcash <cash.costello@gmail.com>2011-12-02 22:05:50 -0500
committercash <cash.costello@gmail.com>2011-12-02 22:05:50 -0500
commitc4ed70ad4cf233f6091f6de22a5cfaf81ea88747 (patch)
tree0dcaaf83e169d6d7d906675c64464700545ea884 /README
parent98acc22fec2dc7942e5c6e5bcdd2e6a356c6e905 (diff)
downloadelgg-c4ed70ad4cf233f6091f6de22a5cfaf81ea88747.tar.gz
elgg-c4ed70ad4cf233f6091f6de22a5cfaf81ea88747.tar.bz2
Elgg 1.8 version
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.