X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2FREADME.markdown;h=ff9f4bbb2b82b3e8a6d062fe1a193f4a678e8844;hb=ed0c8188d49fe524bb305fd44ab027fdbacb70bd;hp=49d415ddb77d088673371e41e3989ce5b0715587;hpb=697da818a4a182e4ae50c13b6937226fa3ba921f;p=mkws-moved-to-github.git
diff --git a/doc/README.markdown b/doc/README.markdown
index 49d415d..ff9f4bb 100644
--- a/doc/README.markdown
+++ b/doc/README.markdown
@@ -1,27 +1,31 @@
% The MasterKey Widget Set
% Mike Taylor; Wolfram Schneider
-% 10 July 2013
+% 28 July 2014
Introduction
------------
-This is the MasterKey Widget Set. The initial version was based on the
-"jsdemo" application distributed with pazpar2, but it is now far
-removed from those beginnnings.
+This is the MasterKey Widget Set. It provides a way to insert
+searching and other information-related functionality into existing
+web pages as small snippets of HTML.
As much of the searching functionality as possible is hosted on
-so that very simple websites such as
-
+so that very simple applications such as
+
can have MasterKey searching with minimal effort.
The following files are hosted on `mkws.indexdata.com`:
-* `mkws.js`
+* `mkws.js` (and its compressed version `mkws.min.js`)
* `/pazpar2/js/pz2.js`
-* `mkws-complete.js` -- a single file consisting of `mkws.js`,
- jQuery (which it uses), Handlebars (ditto) and `pz2.js`
+* `mkws-complete.js` (and its compressed version `mkws-complete.min.js`)
+ -- a single file consisting of `mkws.js` together with the files it
+ uses: `pz2.js` jQuery, jQuery-JSON and Handlebars.
+* Local copy of `jquery-1.10.0.min.js`
+* Local copy of `jquery.json-2.4.js`
+* Local copy of `handlebars-v1.1.2.js`
* `mkws.css`
@@ -65,38 +69,23 @@ will be filled in by MKWS:
* `` -- summary statistics
You can configure and control the client by creating an `mkws_config`
-object _before_ loading the widget-set. Here is an example of all
-possible options:
+object before loading the widget-set. Here is an example showing how
+to use options to offer a choice between English and German UI
+languages, and to default to sorting by title ascending:
~~~
~~~
-For much more detail, see
-[the MKWS whitepaper](whitepaper.html).
+For much more detail, see:
+[Embedded metasearching with the MasterKey Widget Set](mkws-manual.html)
- - -
-Copyright 2013 IndexData ApS.
+Copyright 2014 IndexData ApS.