X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2FREADME.markdown;h=57f399357ac8d3b656e80dfd61f5438517482722;hb=9c77ee20763651018712f75847a7bb19d05dbd13;hp=49d415ddb77d088673371e41e3989ce5b0715587;hpb=697da818a4a182e4ae50c13b6937226fa3ba921f;p=mkws-moved-to-github.git

diff --git a/doc/README.markdown b/doc/README.markdown
index 49d415d..57f3993 100644
--- a/doc/README.markdown
+++ b/doc/README.markdown
@@ -1,14 +1,14 @@
 % The MasterKey Widget Set
 % Mike Taylor; Wolfram Schneider
-% 10 July 2013
+% 23 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 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
 	<http://mkws.indexdata.com/>
@@ -18,10 +18,14 @@ 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,30 +69,15 @@ will be filled in by MKWS:
 * `<div id="mkwsStat"></div>` -- 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:
 
 ~~~
     <script type="text/javascript">
       var mkws_config = {
-        use_service_proxy: true,    /* true, flase: use service proxy instead pazpar2 */
-        show_lang: true,            /* true, false: show/hide language menu */
-        show_sort: true,            /* true, false: show/hide sort menu */
-        show_perpage: true,         /* true, false: show/hide perpage menu */
-        lang_options: ["en", "de", "da"],
-                                    /* display languages links for given languages, [] for all */
-        facets: ["xtargets", "subject", "author"],
-                                    /* display facets, in this order, [] for none */
-        sort_default: "relevance",  /* "relevance", "title:1", "date:0", "date:1" */
-        query_width: 50,            /* 5..50 */
-        perpage_default: 20,        /* 10, 20, 30, 50 */
-        lang: "en",                 /* "en", "de", "da" */
-        debug_level: 0,             /* debug level for development: 0..2 */
-
-        responsive_design_wodth: 600,    /* page reflows for devices < 600 pixels wide */
-        pazpar2_url: "/service-proxy/",            /* URL */
-        service_proxy_auth: "/service-proxy-auth", /* URL */
-        // TODO: language_*, perpage_options, sort_options
+        lang_options: ["en", "de" ],
+        sort_default: "title:1"
       };
     </script>
 ~~~
@@ -99,4 +88,4 @@ For much more detail, see
 
 - - -
 
-Copyright 2013 IndexData ApS. <http://indexdata.com>
+Copyright 2014 IndexData ApS. <http://indexdata.com>