Document API, changelog and contributing.

CHANGELOG.md

@@ -0,0 +1,10 @@
+Changelog
+=========
+
+### `v0.0.1` 2014-08-25
+
+ * Initial release.
+ * Feature: Extract with full paths: `Zip.extractFull`
+ * Feature: Extract: `Zip.extract`.
+
+> Dates are in *ISO 8601* format (year-month-day)

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+Contributing :heart:
+====================
+
+Thanks for your interest! In order to keep the code coherent there are some
+easy-to-follow rules.
+
+ * Use [JSHint](http://www.jshint.com) and respect the `.jshintrc` file.
+ * Use [EditorConfig](http://www.editorconfig.com) and respect the
+   `.editorconfig` file.
+ * Write test for your modifications (use `mocha` and `chai` modules).
+ * Keep the code coverage as high as possible (100% is awesome!). Install
+   `istanbul` module and run `npm run coverage` to check it.
+ * Proudly add yourself to the contributors in `package.json`! :+1:

README.md

@@ -11,7 +11,7 @@ Usage
 I chose to use *Promises* in this library. API is consistent with standard use:
 
 ```js
-var Zip = require('7z');
+var Zip = require('7z'); // Name the class as you want!
 var myTask = new Zip();
 myTask.extractFull('myArchive.7z', 'destination', { p: 'myPassword' })
 
@@ -45,7 +45,7 @@ npm install --save 7z
 API
 ---
 
-### Extract with full paths: `extractFull`
+### Extract with full paths: `Zip.extractFull`
 
 **Arguments**
  * `archive` The path to the archive you want to analyse.
@@ -60,7 +60,7 @@ API
  * `err` An Error object. Its message is the message outputed by 7-Zip.
  * `code` 7-Zip [exit code](http://sevenzip.sourceforge.jp/chm/cmdline/exit_codes.htm).
 
-### Extract: `extract`
+### Extract: `Zip.extract`
 
 **Arguments**
  * `archive` The path to the archive you want to analyse.

package.json

@@ -19,6 +19,7 @@
     "wrapper"
   ],
   "author": "Quentin Rossetti <[email protected]>",
+  "contributors": [],
   "license": "ISC",
   "bugs": {
     "url": "https://github.com/quentinrossetti/node-7zip/issues"