X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Findex.markdown;h=e69fbaee4da3b038a08fa862b814bce968948d9d;hb=64badc9ed1e07c9ab3d00802cf10d867b6965816;hp=2f4a06947f4a08c93f8425f65605ae32b82e1a6b;hpb=7bac0889ac2cf1032c4eceb2334f7d348d7c78a0;p=mkws-moved-to-github.git diff --git a/doc/index.markdown b/doc/index.markdown index 2f4a069..e69fbae 100644 --- a/doc/index.markdown +++ b/doc/index.markdown @@ -10,9 +10,27 @@ The MasterKey Widget Set provides the easiest possible way to enhance an existing web-site with customised searching across multiple sources, ranking and merging the results. -All you need to do is pull in our JavaScript and optional stylesheet, -then add `
`s to your page that have special `class` attributes. We -do the rest. +As much of the searching functionality as possible is hosted on + so that very simple applications such as + can have MasterKey +searching with minimal effort. All you need to do is pull in our +JavaScript and optional stylesheet, then add `
`s to your page +that have special `class` attributes. We do the rest. + +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 A minimal example ----------------- @@ -20,8 +38,7 @@ A minimal example Here is a completely functional (though ugly) MKWS-based searching application: - +
@@ -31,10 +48,14 @@ else is refinement. Documentation ------------- +* This file. + [PDF version] * The README -- mostly technical details. + [PDF version] * The MKWS manual, including a reference section. - This is a much better introduction. + [PDF version] * The MKWS developers' guide. + [PDF version] Tools ----- @@ -68,8 +89,7 @@ Minified versions of the MKWS JavaScript files are also available: * mkws.min.js * mkws-complete.min.js -Versions --------- +### Specific versions The links above to the various forms of the widget-set JavaScript (mkws.js,