diff --git a/README.md b/README.md index 8f80eaf..cbe6330 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,15 @@ BloomJS ==== - A javascript search engine for static websites. + +Have you ever dreamt of having a search engine on your static website ? BloomySearch implements a static index generation, when you generate your webpages, and a client-side JavaScript script which actually implements all the search logic. It downloads the index and performs the search query. + +To preserve bandwith, the index is stored in a binary file, using BloomFilters, instead of using a JSON index as Lunr.JS does. + +For full details about BloomySearch, please refer to this blog post. + + ## Basic idea I have a static weblog, generated thanks to [Blogit](https://github.com/phyks/blogit, caution this code is ugly) and, as I only want to have html files on my server, I needed to find a way to enable users to search my blog. diff --git a/data/test b/data/test deleted file mode 100644 index 658b8a8..0000000 Binary files a/data/test and /dev/null differ diff --git a/data/words b/data/words deleted file mode 100644 index 3058f6f..0000000 Binary files a/data/words and /dev/null differ diff --git a/index.html b/index.html index 402c6db..ff8b7b7 100644 --- a/index.html +++ b/index.html @@ -30,6 +30,11 @@
Have you ever dreamt of having a search engine on your static website ? BloomySearch implements a static index generation, when you generate your webpages, and a client-side JavaScript script which actually implements all the search logic. It downloads the index and performs the search query.
+ +To preserve bandwith, the index is stored in a binary file, using BloomFilters, instead of using a JSON index as Lunr.JS does.
+ +For full details about BloomySearch, please refer to this blog post.