X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2FREADME.markdown;h=433ffe1823da3efce23fb07421fd627fbcc50a5e;hb=20cc407a460346e4baf84ec4af56e7e924950150;hp=b8e51516d16517f7a23d26fb25ac9f0205f67f26;hpb=af19522c83a00b4e4a4e34e9834cbd16d9fb1a7d;p=mkws-moved-to-github.git
diff --git a/doc/README.markdown b/doc/README.markdown
index b8e5151..433ffe1 100644
--- a/doc/README.markdown
+++ b/doc/README.markdown
@@ -1,33 +1,19 @@
% The MasterKey Widget Set
% Mike Taylor; Wolfram Schneider
-% 10 July 2014
+% 28 July 2014
Introduction
------------
-This is the MasterKey Widget Set. It provides searching and other
-information-related functionality which can be inserted 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` (and its compressed version `mkws.min.js`)
-* `/pazpar2/js/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`
-
Supported Browsers
------------------
@@ -69,39 +55,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 2014 IndexData ApS.
+Copyright 2014 Index Data ApS.