merge :: 'devel' of github.com:mimetnet/node-stream-array

* 'devel' of github.com:mimetnet/node-stream-array:
  index.js :: 'use strict'
  index.js :: add jsdoc comments to make Inch CI happy
  README.md :: include Inch CI badge for documentation
  package.json :: update structure
  travis.yml :: test against node v4
  travis.yml :: use build containers & disable email
  package.json :: 1.1.2-beta

Author: mimetnet

.travis.yml

@@ -1,5 +1,10 @@
+sudo: false
+
 language: node_js
 
+notifications:
+  email: false
+
 before_install:
   - '[ "${TRAVIS_NODE_VERSION}" != "0.8" ] || npm install -g npm@1.4.28'
   - npm install -g npm@latest
@@ -13,6 +18,7 @@ node_js:
   - '0.8'
   - '0.10'
   - '0.12'
+  - '4'
   - 'iojs-v1.0.0'
   - 'iojs-v2.0.0'
   - 'iojs-v3.0.0'

README.md

@@ -7,6 +7,7 @@ other streams.
 [![build status][3]][4]
 [![dependencies][5]][6]
 [![devDependencies][7]][8]
+[![Inch CI][16]][17]
 
 [//]: [![testling][9]][10]
 
@@ -71,6 +72,8 @@ npm install stream-array
   [13]: http://nodejs.org/api/globals.html#globals_require
   [14]: https://nodejs.org/api/stream.html#stream_readable_push_chunk_encoding
   [15]: https://nodejs.org/api/stream.html#stream_readable_pipe_destination_options
+  [16]: https://inch-ci.org/github/mimetnet/node-stream-array.svg?branch=master
+  [17]: http://inch-ci.org/github/mimetnet/node-stream-array
 
 ## License
 

index.js

@@ -1,6 +1,14 @@
+'use strict'
+
 var Readable = require('readable-stream').Readable
 ;
 
+/**
+ * Create a new instance of StreamArray
+ *
+ * @access private
+ * @param {Array} list
+ */
 function StreamArray(list) {
     if (!Array.isArray(list))
         throw new TypeError('First argument must be an Array');
@@ -14,10 +22,25 @@ function StreamArray(list) {
 
 StreamArray.prototype = Object.create(Readable.prototype, {constructor: {value: StreamArray}});
 
+/**
+ * Read the next item from the source Array and push into NodeJS stream
+
+ * @access protected
+ * @desc Read the next item from the source Array and push into NodeJS stream
+ * @param {number} size The amount of data to read (ignored)
+ */
 StreamArray.prototype._read = function(size) {
     this.push(this._i < this._l ? this._list[this._i++] : null);
 };
 
+/**
+ * Create a new instance of StreamArray
+ *
+ * @module stream-array
+ * @desc Push Array elements through a NodeJS stream
+ * @type {function}
+ * @param {Array} list An Array of objects, strings, numbers, etc
+ */
 module.exports = function(list) {
     return new StreamArray(list);
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "stream-array",
-  "version": "1.1.1",
+  "version": "1.1.2-beta",
   "description": "Pipe an Array through Node.js streams",
   "dependencies": {
     "readable-stream": "~2.0.0"
@@ -20,19 +20,15 @@
   "bugs": {
     "url": "https://github.com/mimetnet/node-stream-array/issues"
   },
+  "homepage": "https://github.com/mimetnet/node-stream-array",
   "keywords": [
     "array",
     "readable",
     "stream",
     "pipe"
   ],
   "author": "Matthew I. Metnetsky <matthew@cowarthill.com>",
-  "license": [
-    {
-      "type": "MIT",
-      "url": "http://opensource.org/licenses/MIT"
-    }
-  ],
+  "license": "MIT",
   "main": "index.js",
   "directories": {
     "test": "test"
@@ -55,7 +51,7 @@
       "android-browser/4.2..latest"
     ]
   },
-  "engines": [
-    "node >= 0.8.0"
-  ]
+  "engines": {
+    "node" : ">= 0.8"
+  }
 }