badabloom - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "badabloom",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "BadaBloom dictionary",
@@ -5,0 +5,0 @@ "main": "lib/badabloom.js",

README.md

@@ -1,5 +0,33 @@
-# badabloom
+# BadaBloom
 
-**WORK IN PROGRESS/EXPERIMENTAL**
+In-memory backend for [HyperBloom][0].
 
+## Usage
+
+```js
+const BadaBloom = require('badabloom');
+
+const bloom = new BadaBloom();
+
+bloom.insert(Buffer.from('value'));
+bloom.bulkInsert([ Buffer.from('other') ]);
+
+bloom.has(Buffer.from('value'));
+
+// Sync
+
+const other = new BadaBloom();
+other.insert(Buffer.from('other'));
+
+other.sync(bloom.getRawFilter());  // [ Buffer.from('value') ]
+
+// Request
+
+bloom.request({ start: Buffer.from('a'), end: Buffer.from('z') }, limit);
+
+// Filter options
+
+bloom.getFilterOptions();
+```
+
 ## LICENSE
@@ -29,1 +57,3 @@
 USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+[0]: https://github.com/hyperbloom/hyperbloom

No alert changes

Improved metrics

Total package byte prevSize

14584

increased by3.8%

Number of lines in readme file

59

increased by103.45%

No dependency changes