X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2FREADME.markdown;h=ff9f4bbb2b82b3e8a6d062fe1a193f4a678e8844;hb=3271437c3795ec604b1aa8abdf3e052a072ff070;hp=50f057c31d6f0a45dfd75e3efea4095758de31cd;hpb=9649f489095c371d02dc8ec207b006d6adde4d34;p=mkws-moved-to-github.git diff --git a/doc/README.markdown b/doc/README.markdown index 50f057c..ff9f4bb 100644 --- a/doc/README.markdown +++ b/doc/README.markdown @@ -1,19 +1,19 @@ % The MasterKey Widget Set % Mike Taylor; Wolfram Schneider -% 10 July 2014 +% 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`: @@ -69,37 +69,21 @@ 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) - - -