Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cebe committed Apr 26, 2014
1 parent 503449f commit c85c42d
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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][].

Expand Down Expand Up @@ -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 <path-to-your-html-files>
```

This will generate a `jssearch.index.js` file that you have to include in the Html header.

0 comments on commit c85c42d

Please sign in to comment.