Merge pull request #150 from DavidVujic/md-files

Add: Changelog and Contributing info

Author: DavidVujic

CHANGELOG.md

@@ -0,0 +1,14 @@
+#### v 4.0.1 (2019-03-10)
+* Added docs: changelog, contributing to the project, fixed typos and missing info in the readme file.
+
+#### v 4.0.0 (2019-03-02)
+* Added Windows support! A long awaited issue finally solved.
+* __BREAKING__: dropped support for Node.js versions oldder than version 8.
+* `node-zookeeper` now uses __SemVer__ for versioning.
+
+Read details about the release here: [Windows support](https://github.com/yfinkelstein/node-zookeeper/pull/145)
+
+#### v 3.4.9-4 (2019-01-16)
+* Fixed npm install fails when using Node version 10.
+
+Details about the release here: [Node.js 10 support](https://github.com/yfinkelstein/node-zookeeper/pull/142)

CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing to the development of node-zookeeper
+
+Fork this repo, write code and send a pull request. Easy!
+
+### Guidelines
+* Create a branch for the feature you are about to write.
+* If possible, isolate the changes in the branch to the feature only. Merges will be easier if general refactorings, that are not specific to the feature, are made in separate branches.
+* If possible, avoid general dependency updates in the feature branch.
+* If possible, send pull requests early. Don't wait too long, even if the feature is not completely done. The new code can very likely be merged without causing any problems (if the code changes are not of type breaking features). Think of it as "silent releases".
+* If you think it is relevant and add value: write unit test(s). Use the`tape` unit test library. They could also be valuable as description of features.

README.md

@@ -1,8 +1,16 @@
 # Overview
 
-node-zookeeper - A Node.js client for Apache Zookeeper.
+_node-zookeeper - A Node.js client for Apache Zookeeper._
 
-This module is implemented on top of the ZooKeeper C API; consult the [ZK Reference](http://zookeeper.apache.org/doc/r3.4.0/index.html) for further details on behavior.
+This module is implemented on top of the ZooKeeper C API; consult the [ZK Reference](http://zookeeper.apache.org/doc/r3.4.13/index.html) for further details on behavior.
+
+__Latest changes__ are described in the [changelog](./CHANGELOG.md)
+
+## Installation
+(note the name `zookeeper` in lowercase)
+```bash
+npm install zookeeper
+```
 
 # Example
 
@@ -286,6 +294,9 @@ DDOPSON-2011-11-30 - are these issues still relevant?  unknown.
 - Any established watches may/will be fired once each when/if your client is expired by the ZK server, the input arguments are observed to be: type=-1, state=1, path="". Care should be taken to handle this differently than a "real" watch event if that matters to your application.
 - Otherwise, it just works!
 
+# Contribute to the project
+Check out the issues tab and grab one! Read the [contributing](./CONTRIBUTING.md) document.
+
 # See Also
 
 - [http://zookeeper.apache.org/releases.html](http://zookeeper.apache.org/releases.html)

package.json

@@ -1,7 +1,7 @@
 {
   "name": "zookeeper",
   "description": "apache zookeeper client (zookeeper async API >= 3.4.0)",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "author": "Yuri Finkelstein <[email protected]>",
   "license": "MIT",
   "contributors": [