Merge pull request #247 from DavidVujic/release-4.6.0

feat: bump package version, update documentation

Author: DavidVujic

CHANGELOG.md

@@ -1,3 +1,8 @@
+#### v 4.6.0 (2020-10-31)
+* feat: The default API from the library is the async/await enabled client (containing both callbacks and promisified methods)
+* fix: add TypeScript declarations.
+Pull request [246](https://github.com/yfinkelstein/node-zookeeper/pull/246) by @davidvujic
+
 #### v 4.5.3 (2020-09-20)
 * fix: Update depencencies causing warnings on install. Pull request [242](https://github.com/yfinkelstein/node-zookeeper/pull/242) by @davidvujic
 

README.md

@@ -18,21 +18,19 @@ npm install zookeeper
 
 ## Examples
 
-Use the `async/await` enabled client:
-
 ```javascript
-const ZooKeeper = require('zookeeper').Promise;
+const ZooKeeper = require('zookeeper');
 ```
 
-Note: checkout the API for the [async/await enabled client here](#methods-asyncawait-enabled-client)
+The ZooKeeper client support both callbacks and `async/await`.
 
-There is also a callbacks based client:
+### Documentation
+The source code is documented with `JSDoc` code comments and `TypeScript` type declarations. 
 
-```javascript
-const ZooKeeper = require('zookeeper');
-```
+Also, have a look at the API documentation here: 
+* [async/await enabled methods](#methods-asyncawait-enabled-client-methods)
+* [callback enabled methods](#methods-callbacks-based-client-methods)
 
-Note: checkout the API for the [callback based client here](#methods-callbacks-based-client)
 
 ### Example: create a client
 
@@ -83,7 +81,7 @@ Check out the code in the [examples](./examples) folder: master,workers, tasks a
 
 ## API Reference
 
-### Methods: async/await enabled client
+### Methods: async/await enabled client methods
 
 * `init(options)`
 * `connect(options, connect_cb)`
@@ -115,7 +113,7 @@ Check out the code in the [examples](./examples) folder: master,workers, tasks a
         * children is an array of strings
         * stat is an object
 
-### Methods: callbacks based client
+### Methods: callbacks based client methods
 
 * `init(options)`
 * `connect(options, connect_cb)`
@@ -216,7 +214,7 @@ For more details please refer to ZooKeeper docs.
 
 ## Windows support
 
-Install `CMake` to build a ZooKeeper client on Windows. `Python 2.7.x` is currently required by the tool `node-gyp` to build the ZooKeeper client as a native Node.js Addon.
+Install `CMake` to build a ZooKeeper client on Windows. Install Python.
 
 Also, run `npm install` in a Powershell window. For further instructions visit [node-gyp documentation](https://github.com/nodejs/node-gyp/#on-windows).
 

package.json

@@ -1,7 +1,7 @@
 {
     "name": "zookeeper",
-    "description": "apache zookeeper client (zookeeper async API v3.4.x - v3.5.x)",
-    "version": "4.5.3",
+    "description": "apache zookeeper client (zookeeper async API v3.4.x - v3.6.x)",
+    "version": "4.6.0",
     "author": "Yuri Finkelstein <[email protected]>",
     "license": "MIT",
     "contributors": [