From 837199ef9dfa8d5a7779734edb4ea2b6bbb7baac Mon Sep 17 00:00:00 2001 From: Phyks Date: Sat, 8 Nov 2014 18:42:20 +0100 Subject: [PATCH] Update doc + remove useless files --- README.md | 9 ++++++++- data/test | Bin 12 -> 0 bytes data/words | Bin 248 -> 0 bytes index.html | 5 +++++ 4 files changed, 13 insertions(+), 1 deletion(-) delete mode 100644 data/test delete mode 100644 data/words 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 658b8a864a8e88fcc42a08633e6ef57591378a8f..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 12 RcmZQ%U|?Vb;*N#|O#lUg0xbXl diff --git a/data/words b/data/words deleted file mode 100644 index 3058f6fd2ec64b78fc5423eb67378d3e4852f2f2..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 248 zcmeytz`($&r>9?>m|KvOTCAU3R9R4xl3JFToEo27np2Xgmr;_N!(a|n#<0i4Zr2In z-tMW_UH`sw=Q>$4KO*aUua{i?&xe!Oyg#bF{MsJZip3uLrdKq+`SWjc?W{W&C(qcn z3fcIK%=C=h{Ji+`)YRmR#1e?%c_72@JXz~yf4Hw+Wq#a`pJ&*AUEQ`ova+gt#lG|@ zg3hN;#((Uc8|Z)B$mX`}+m%Px8~c6P{4jq8cg^AX@2t<16)S4H#mtv|(7erV*D>yd pnz^?378@7W{jOR%DfCv_Cb@m-udBaqkJ38*onryhhL!u+832V>b_)Oi diff --git a/index.html b/index.html index 402c6db..ff8b7b7 100644 --- a/index.html +++ b/index.html @@ -30,6 +30,11 @@

More about BloomySearch


+

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.