Merge branch 'master' into major-cleanup

.npmignore

@@ -1,10 +1,11 @@
 /.idea
+/coverage
 /doc
+/output
 /specs
 /test
 /output
 /typings
-/coverage
 .jshintrc
 .npmignore
 .travis.yml

.travis.yml

@@ -1,6 +1,7 @@
 language: node_js
 node_js:
-  - 4
+  - "4"
+  - "6"
 script:
   - npm run jsHint -- --failTaskOnError
   - npm run test -- --failTaskOnError --suppressPassed

CHANGES.md

@@ -1,6 +1,11 @@
 Change Log
 ==========
 
+### 0.1.7 2017-01-06
+
+* Update gltf-pipeline to 0.1.0-alpha9
+* Added command to generate documentation (npm run jsdoc)
+
 ### 0.1.6 2016-09-07
 
 * Changed obj2gltf.js line endings from CRLF to LF in npm package.

README.md

@@ -49,6 +49,45 @@ Using obj2gltf as a command-line tool:
 |`--ao`|Apply ambient occlusion to the converted model.|No, default `false`|
 |`--bypassPipeline`|Bypass the gltf-pipeline for debugging purposes. This option overrides many of the options above and will save the glTF with the KHR_materials_common extension.|No, default `false`|
 
+## Build Instructions
+
+Run the tests:
+```
+npm run test
+```
+To run JSHint on the entire codebase, run:
+```
+npm run jsHint
+```
+To run JSHint automatically when a file is saved, run the following and leave it open in a console window:
+```
+npm run jsHint-watch
+```
+
+### Running Test Coverage
+
+Coverage uses [istanbul](https://github.com/gotwarlost/istanbul).  Run:
+```
+npm run coverage
+```
+For complete coverage details, open `coverage/lcov-report/index.html`.
+
+The tests and coverage covers the Node.js module; it does not cover the command-line interface, which is tiny.
+
+## Generating Documentation
+
+To generate the documentation:
+```
+npm run jsdoc
+```
+
+The documentation will be placed in the `doc` folder.
+
+### Debugging
+
+* To debug the tests in Webstorm, open the Gulp tab, right click the `test` task, and click `Debug 'test'`.
+* To run a single test, change the test function from `it` to `fit`.
+
 ## Contributions
 
 Pull requests are appreciated.  Please use the same [Contributor License Agreement (CLA)](https://github.com/AnalyticalGraphicsInc/cesium/blob/master/CONTRIBUTING.md) used for [Cesium](http://cesiumjs.org/).

package.json

@@ -1,6 +1,6 @@
 {
   "name": "obj2gltf",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "Convert OBJ model format to glTF",
   "license": "Apache-2.0",
   "contributors": [
@@ -47,11 +47,13 @@
   },
   "scripts": {
     "prepublish": "typings install",
+    "jsdoc": "jsdoc ./lib -R ./README.md -d doc",
     "jsHint": "gulp jsHint",
     "jsHint-watch": "gulp jsHint-watch",
     "test": "gulp test",
     "test-watch": "gulp test-watch",
-    "coverage": "gulp coverage"
+    "coverage": "gulp coverage",
+    "coveralls": "cat ./coverage/lcov.info | ./node_modules/.bin/coveralls"
   },
   "bin": {
     "obj2gltf": "./bin/obj2gltf.js"