Merge pull request #84 from silverbucket/release-3.0.0

Release 3.0.0

.github/workflows/compliance.yml

@@ -33,6 +33,8 @@ jobs:
         run: npm run build
       - name: Test
         run: npm run test
+      - name: Coverage
+        run: npm run coverage
 
   integration:
     runs-on: ubuntu-latest

README.md

@@ -13,8 +13,6 @@ a number of connections in a pool, using them as needed and keeping all aspects
 of releasing active connections internal to the object, so the user does not
 need to worry about forgotten connections leaking resources.
 
-**NOTE** Version 2.x is a rewrite and not backward compatible, please re-read the documentation to update your code.
-
 ## Installation
 
 ```javascript
@@ -117,6 +115,10 @@ lpush(key, value)
 sendCommand(commandName, [args])
 ```
 
+* **shutdown**
+```javascript
+shutdown()
+```
 
 ## API Documentation
 node-redis-connection-pool uses jsdoc-to-markdown to generate the [API.md](API.md) from the source code.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis-connection-pool",
-  "version": "2.0.4",
+  "version": "3.0.0",
   "description": "a redis client connection pool",
   "license": "MIT",
   "private": false,
@@ -27,6 +27,7 @@
     "lint:fix": "npx eslint --fix src/",
     "lint": "npx eslint src/",
     "test": "c8 -x src/bootstrap -x \"src/**/*.test.*\" mocha -r ts-node/register src/*.test.ts",
+    "coverage": "c8 check-coverage --statements 70 --branches 90 --functions 60 --lines 70",
     "integration": "mocha -r ts-node/register src/index.integration.ts && yarn run build && mocha dist/index.integration.js",
     "doc": "jsdoc2md --files ./src/index.ts --configure ./jsdoc2md.json > ./API.md"
   },