Add description of what's what in this module.
authorMike Taylor <mike@indexdata.com>
Fri, 14 Jun 2013 11:01:56 +0000 (12:01 +0100)
committerMike Taylor <mike@indexdata.com>
Fri, 14 Jun 2013 11:01:56 +0000 (12:01 +0100)
README

diff --git a/README b/README
index 0823a10..370c54e 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,6 @@
+OVERVIEW
+========
+
 The MasterKey Widget Set, or MKWS, is a project to create some very
 simple HTML/JS/CSS widgets that can be dropped into ANY website,
 irrespective of CMS or lack thereof, to enable MasterKey searching.
@@ -7,3 +10,17 @@ The top level bug for discussing this is
 and a high-level description can be found at
         https://twiki.indexdata.com/twiki/bin/view/ID/MasterKeyWidgetSet
 
+
+WHAT'S WHAT
+===========
+
+experiments -- a directory containing code experiments:
+       jquery-ui -- Using a JQuery UI element
+       jsdemo -- The basic pazpar2 client, running locally
+       spclient -- Mike's hardly-there sketch
+       spdemo -- Wolfram's functioning jsdemo-targeted-at-SP
+
+etc -- configuration files for the various experiments
+       apache2 -- configuration for running spdemo
+       service-proxy -- config for running a local Service Proxy
+