moolb-js

commit 66e8ec576556b5f84237dc659eab00e1923caf13
parent 8ddb1aad20f202fe9306905daba4eb48421cedcc
Author: nolash <dev@holbrook.no>
Date:   Fri, 30 Oct 2020 22:30:20 +0100

Add README

Diffstat:
A
README.md
 | 
25
+++++++++++++++++++++++++

1 file changed, 25 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+# moolb.js
+
+Bloom filter for python with pluggable hasher backend
+
+## USAGE
+
+```
+let assert = require('assert');
+
+let ref = b = new moolb.Bloom(8192 * 8, 3);
+let enc = new TextEncoder();
+
+let v = enc.encode('1024');
+b.add(v);
+let r = b.check(v);
+assert(r);
+
+v = enc.encode('1023');
+r = b.check(v);
+assert(!r)
+```
+
+## LICENSE
+
+GPL3