From c85c42dcc951637728aa30c3cb823088d10a3fd2 Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Sat, 26 Apr 2014 14:41:54 +0200 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b61fd9..6b4edaa 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This is a client side search engine for use on static pages. It uses a pre-compiled search index to add a fulltext search to static HTML pages such as [github pages][] or offline API documentation. The index is built by a PHP script using a -similar yet much more simplified and dump approach than the popular search enging [Lucene]. +similar yet much more simplified and dump approach than the popular search engine [Lucene]. To see how it looks like, check out the [demo][]. @@ -34,3 +34,12 @@ Usage TODO. See [example.html](example.html) for an implementation. + +### Generate the index + +Using the command line tool: +``` +vendor/bin/jsindex +``` + +This will generate a `jssearch.index.js` file that you have to include in the Html header.