Update list of what's provided.

[mkws-moved-to-github.git] / README

diff --git a/README b/README
index 5696cd1..927ee56 100644 (file)
--- a/README
+++ b/README
@@ -1,19 +1,23 @@
 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.
+The MasterKey Widget Set, or MKWS, provides HTML/JS/CSS widgets that
+can be dropped into ANY website, irrespective of CMS or lack thereof,
+to enable MasterKey searching. See the contents of the "doc" directory
+for further documentation.
 
 
 WHAT'S WHAT
 ===========
 
 README   -- this file
+LICENSE  -- The GNU LGPL (Lesser General Public Licence)
 Makefile -- delegates to tools/htdocs/Makefile
+src      -- source-code that is compiled into the tools area
 tools   -- the tools that make up the Widget Set
 examples -- examples of applications that use MKWS
-
+doc      -- documentation (in Markdown, compiles to HTML)
+test     -- regression-testing scripts
 notes    -- internal documents, not for customers
 
 
@@ -30,6 +34,11 @@ or you can download the source from http://nodejs.org/download/ and build
 it yourself. Looks like you need node and npm, make install puts them
 into /usr/local/bin.
 
+To compile the default templates you'll need to install the stable version
+of Handlebars. Currently it's at 1.3.0 and available by npm:
+
+  npm install handlebars@1.3.0 -g
+
 For apache setup, see tools/apache2/README
 
 NEWS