Bump version to 2.0.0-canary.0

CHANGELOG.md

@@ -1,29 +1,49 @@
 # CHANGELOG
 
+## v2.0.0-canary.0
+
+### FEATURES
+
+- Rewrite with TypeScript
+- Remove unnecessary default behaviors
+- Add `CountMinSketch` and `TopKFilter`
+
 ## v1.1.0
 
-- NEW: Support the ability to reset the filter. You can set `Options.reset = true` to automatically reset on connected
+### FEATURES
+
+- Support the ability to reset the filter. You can set `Options.reset = true` to automatically reset on connected
 
 ## v1.0.0
 
-- NEW: Now you can use _Red_ options with `Options.redisClientOptions`
-- CHANGED: Remove `Options.password`
+### FEATURES
+
+- Now you can use _Red_ options with `Options.redisClientOptions`
+- Remove `Options.password`
 
 ## v1.0.0-canary.0
 
-- NEW: Support using a custom Redis client
-- NEW: Support Redis client authentication
-- NEW: Start writing documentation with _JSDoc_
-- CHANGED: No longer load RedisBloom module internally
+### FEATURES
+
+- Support using a custom Redis client
+- Support Redis client authentication
+- Start writing documentation with _JSDoc_
+- No longer load RedisBloom module internally
 
 ## v0.1.1, v0.1.2
 
-- FIXED: 2 attempts to fix missing .so file
+### PATCHES
+
+- Attempt to fix missing .so file
 
 ## v0.1.0
 
-- NEW: Remove redundant to-string conversions
+### FEATURES
+
+- Remove redundant to-string conversions
 
 ## v0.1.0-beta.0
 
-- NEW: Mapping basic features of RedisBloom
+### FEATURES
+
+- Mapping basic features of RedisBloom

README.md

@@ -1,35 +1,40 @@
 [![](https://img.shields.io/github/license/albert-team/rebloom.svg?style=flat-square)](https://github.com/albert-team/rebloom)
-[![](https://img.shields.io/npm/v/@albert-team/rebloom/latest.svg?style=flat-square)](https://www.npmjs.com/package/@albert-team/rebloom)
+[![](https://img.shields.io/npm/v/@albert-team/rebloom.svg?style=flat-square)](https://www.npmjs.com/package/@albert-team/rebloom)
 
 # REBLOOM
 
-> Bloom filter and Cuckoo filter for Node.js using Redis with [RedisBloom](https://github.com/RedisLabsModules/redisbloom) module
+> Minimalistic [RedisBloom][0] client for Node.js
 
 ## Installation
 
 ### Requirements
 
 - Node.js >= 8.0.0
 - Redis >= 4.0
-- RedisBloom >= 1.1.0
+- [RedisBloom][0] >= 2.0.0
 
 ### Instructions
 
-- With npm:
+#### With `npm`
 
 ```bash
 npm i @albert-team/rebloom
 ```
 
-- With yarn:
+#### With `yarn`
 
 ```bash
 yarn add @albert-team/rebloom
 ```
 
 ## Usage
 
-**Important**: [RedisBloom](https://github.com/RedisLabsModules/redisbloom) module needs to be loaded into Redis server beforehand.
+**Important**:
+
+- Rebloom v2 is nearly a rewrite from scratch, thus not backward-compatible with Rebloom v1.
+- [RedisBloom][0] module needs to be loaded into Redis server beforehand.
+
+### Get Started
 
 ```js
 const { BloomFilter } = require('@albert-team/rebloom')
@@ -38,18 +43,20 @@ const main = async () => {
   const filter = new BloomFilter('filtername')
   await filter.connect()
 
-  console.log(await filter.add('item0'))
-  console.log(await filter.exists('item0'))
-  console.log(await filter.addMany('item1', 'item2'))
-  console.log(await filter.exists('item1'))
-  console.log(await filter.exists('item3'))
+  console.log(await filter.add('item0')) // 1
+  console.log(await filter.exists('item0')) // 1
+  console.log(await filter.exists('item1')) // 0
 
   await filter.disconnect()
 }
 
 main()
 ```
 
+### API
+
 ## Changelog
 
 Read more [here](https://github.com/albert-team/rebloom/blob/master/CHANGELOG.md).
+
+[0]: https://github.com/RedisLabsModules/redisbloom

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@albert-team/rebloom",
-  "description": "Bloom filter and Cuckoo filter for Node.js using Redis with RedisBloom module",
+  "description": "Minimalistic RedisBloom client for Node.js",
   "license": "MIT",
-  "version": "1.1.0",
+  "version": "2.0.0-canary.0",
   "author": "Albert Team",
   "repository": "github:albert-team/rebloom",
   "main": "dist/index.js",
@@ -31,8 +31,11 @@
   "keywords": [
     "bloom",
     "cuckoo",
+    "topk",
+    "top-k",
     "filter",
-    "redis",
-    "redisbloom"
+    "count-min-sketch",
+    "redisbloom",
+    "redis"
   ]
 }