Update doc + remove useless files

This commit is contained in:
Phyks 2014-11-08 18:42:20 +01:00
parent 010678abbd
commit 837199ef9d
4 changed files with 13 additions and 1 deletions

View File

@ -1,8 +1,15 @@
BloomJS BloomJS
==== ====
A javascript search engine for static websites. 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 <a href="http://lunrjs.com/">Lunr.JS</a> does.
For full details about BloomySearch, please refer to <a href="http://phyks.me/2014/11/bloomysearch.html">this blog post</a>.
## Basic idea ## 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. 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.

BIN
data/test

Binary file not shown.

Binary file not shown.

View File

@ -30,6 +30,11 @@
<h2 class="text-right" style="margin-top: 3em;">More about BloomySearch</h2> <h2 class="text-right" style="margin-top: 3em;">More about BloomySearch</h2>
<hr/> <hr/>
<p>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.</p>
<p>To preserve bandwith, the index is stored in a binary file, using BloomFilters, instead of using a JSON index as <a href="http://lunrjs.com/">Lunr.JS</a> does.</p>
<p>For full details about BloomySearch, please refer to <a href="http://phyks.me/2014/11/bloomysearch.html">this blog post</a>.</p>
</div> </div>
<script type="text/javascript" src="js/bloom.js"></script> <script type="text/javascript" src="js/bloom.js"></script>
<script type="text/javascript" src="js/stemmer.js"></script> <script type="text/javascript" src="js/stemmer.js"></script>