X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2FREADME.markdown;h=c2533f72ffa8a278771dcd32351ec98e03d38839;hb=4ec099efd0efc4c74a940028342013fc4dfdf2a4;hp=b8e51516d16517f7a23d26fb25ac9f0205f67f26;hpb=af19522c83a00b4e4a4e34e9834cbd16d9fb1a7d;p=mkws-moved-to-github.git

diff --git a/doc/README.markdown b/doc/README.markdown
index b8e5151..c2533f7 100644
--- a/doc/README.markdown
+++ b/doc/README.markdown
@@ -1,107 +1,9 @@
 % 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
-	<http://mkws.indexdata.com/>
-so that very simple websites such as
-	<http://example.indexdata.com/>
-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
-------------------
-
-Any modern browser will work fine. JavaScript must be enabled.
-
-* IE8 or later
-* Firefox 17 or later
-* Google Chrome 27 or later
-* Safari 6 or later
-* Opera  12 or later
-* iOS 6.x (iPhone, iPad)
-* Android 4.x
-
-Not supported: IE6, IE7
-
-
-Configuring a client (short version)
-------------------------------------
-
-The application's HTML must contains the following elements as well as
-whatever makes up the application itself:
-
-Prerequisites:
-
-~~~
-	<link rel="stylesheet" href="http://mkws.indexdata.com/mkws.css" />
-	<script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
-~~~
-
-Then the following special `<div>`s can be added (with no content), and
-will be filled in by MKWS:
-
-* `<div id="mkwsSwitch"></div>` -- switch between record and target views
-* `<div id="mkwsLang"></div>  ` -- switch between English, Danish and German
-* `<div id="mkwsSearch"></div>` -- search box and button
-* `<div id="mkwsResults"></div>` -- result list, including pager/sorting
-* `<div id="mkwsTargets"></div>` -- target list, including status
-* `<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:
-
-~~~
-    <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 */
-        show_switch: true,          /* true, false: show/hide switch 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
-      };
-    </script>
-~~~
-
-For much more detail, see
-[the MKWS whitepaper](whitepaper.html).
-
 
 - - -
 
-Copyright 2014 IndexData ApS. <http://indexdata.com>
+Copyright 2014 Index Data ApS. <http://indexdata.com>