diff --git a/CHANGELOG.md b/CHANGELOG.md index 615f6e0..b502abc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # CHANGELOG +## v2.0.0 + +### FEATURES + +- Add _Typedoc_ and generate API documentation + +### PATCHES + +- Upgrade [_Red_](https://github.com/albert-team/red) dependency to fix compatibility issue with Node < v9.11.0 + ## v2.0.0-canary.0 ### FEATURES diff --git a/README.md b/README.md index 200c0a6..7a2235b 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,13 @@ #### With `npm` ```bash -npm i @albert-team/rebloom@canary +npm i @albert-team/rebloom ``` #### With `yarn` ```bash -yarn add @albert-team/rebloom@canary +yarn add @albert-team/rebloom ``` ## Usage @@ -53,6 +53,10 @@ const main = async () => { main() ``` +### API + +Read more [here](https://albert-team.github.io/rebloom). + ## Changelog Read more [here](https://github.com/albert-team/rebloom/blob/master/CHANGELOG.md). diff --git a/docs/classes/basefilter.html b/docs/classes/basefilter.html index 0f12c73..ab77b14 100644 --- a/docs/classes/basefilter.html +++ b/docs/classes/basefilter.html @@ -132,7 +132,7 @@
Protected client
Protected name
Protected options
connect
disconnect
reset
constructor
Protected client
@@ -176,7 +176,7 @@Protected name
@@ -187,7 +187,7 @@Protected options
@@ -204,7 +204,7 @@add
connect
disconnect
exists
reserve
reset
constructor
Protected client
@@ -177,7 +177,7 @@Protected name
@@ -188,7 +188,7 @@Protected options
@@ -205,7 +205,7 @@add
connect
count
disconnect
fromDimensions
fromProbability
reset
constructor
Protected client
@@ -178,7 +178,7 @@Protected name
@@ -189,7 +189,7 @@Protected options
@@ -206,7 +206,7 @@add
connect
count
disconnect
exists
remove
reserve
reset
constructor
Parameters
@@ -140,7 +140,7 @@client
host
@@ -168,7 +168,7 @@port
@@ -179,7 +179,7 @@redisClientOptions
constructor
Protected client
@@ -177,7 +177,7 @@Protected name
@@ -188,7 +188,7 @@Protected options
@@ -205,7 +205,7 @@add
connect
count
disconnect
exists
reserve
reset
Instructions
With
- +npm
With
- +yarn
Usage
@@ -115,6 +115,10 @@Get Started
} main() + +API
+ +Read more here.
Changelog
diff --git a/docs/interfaces/optionsinterface.html b/docs/interfaces/optionsinterface.html index af1ab0b..0ca58a1 100644 --- a/docs/interfaces/optionsinterface.html +++ b/docs/interfaces/optionsinterface.html @@ -107,7 +107,7 @@Optional client
Optional host
Optional port
Optional redisClient
redisClientOptions: object
diff --git a/package.json b/package.json
index 9c4bec1..0f7d99e 100644
--- a/package.json
+++ b/package.json
@@ -2,7 +2,7 @@
"name": "@albert-team/rebloom",
"description": "Minimalistic RedisBloom client for Node.js",
"license": "MIT",
- "version": "2.0.0-canary.0",
+ "version": "2.0.0",
"author": "Albert Team",
"repository": "github:albert-team/rebloom",
"main": "dist/index.js",