prepping for npm publish

Author: Conrad2134

.npmignore

@@ -1 +1,2 @@
 .travis.yml
+TODO.md

Gruntfile.js

@@ -1,10 +1,11 @@
 /*
  * grunt-node-version-windows
  *
+ * Copyright (c) 2016 Connor Uhlman
+ * Licensed under the MIT license.
+ *
  * Fork of grunt-node-version
  * https://github.com/jking90/grunt-node-version
- * Copyright (c) 2013 Jimmy King
- * Licensed under the MIT license.
  */
 
 "use strict";

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013 Jimmy King
+Copyright (c) 2016 Connor Uhlman
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -2,8 +2,80 @@
 
 > A grunt task to ensure you are using the node version required by your project's package.json
 
-#### More info will be available here once the package is released....
+## Getting Started
+This plugin requires Grunt `~0.4.1` and Node.js `>=0.12.14`.
 
-Requires node >=0.12.14
+If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
 
-*Forked from [grunt-node-version](https://github.com/jking90/grunt-node-version) by Jimmy King*
+```shell
+npm install grunt-node-version-windows --save-dev
+```
+
+Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
+
+```js
+grunt.loadNpmTasks('grunt-node-version-windows');
+```
+
+
+## The "node_version" task
+
+### Overview
+In your project's Gruntfile, add a section named `node_version` to the data object passed into `grunt.initConfig()`.
+
+```js
+grunt.initConfig({
+	node_version: {
+		options: {
+			alwaysInstall: false,
+			errorLevel: 'fatal',
+			globals: [],
+			nvm: true,
+			override: "",
+			debug: false
+		}
+	}
+})
+```
+
+### Options
+
+#### options.alwaysInstall
+Type: `Boolean`
+Default value: `false`
+
+A boolean that determines whether to install the latest compatible version of node without a prompt (default behavior prompts user to install). This is primarily intended to be used for deployment.
+
+#### options.errorLevel
+Type: `String`
+Default value: `'fatal'`
+
+The level of error given when the wrong node version is being used. Accepted values are `'warn'` and `'fatal'`. Warn can can be overidden with `--force`, fatal cannot.
+
+#### options.globals
+Type: `Array`
+Default value: `[]`
+
+An array of node modules required to be installed globally for the project.
+
+#### options.nvm
+Type: `Boolean`
+Default value: `true`
+
+A boolean that determines whether to attempt to use/install a version of node compatible with the project using [nvm-windows](https://github.com/coreybutler/nvm-windows). If set to `false`, the plugin will just print an error if the wrong node version is being used.
+
+#### options.override
+Type: `String`
+Default value: `''`
+
+If you want to override the version specified in your project's `package.json`, specify the version you want to use instead here. This is primarily intended for testing projects on other versions of node.
+
+#### options.debug
+Type: `Boolean`
+Default value: `false`
+
+A boolean that turns detailed logging on / off. If set to `true`, a message will be logged to the console each time a new command is executed. This is primarily used for debugging issues and testing.
+
+##### This plugin only works on Windows and with nvm-windows.
+
+*Forked from [grunt-node-version](https://github.com/jking90/grunt-node-version) by Jimmy King.*

TODO.md

@@ -0,0 +1,9 @@
+# TODO
+
+### Now
+- Refactor (eliminate crazy nesting)
+- Unit testing (of what's possible)
+
+### Future
+- Mocking of commands for testing (is it possible?)
+- Are there modules we can use to better interface with npm / nvm-windows?

src/npm.js

@@ -1,10 +1,11 @@
 /*
  * grunt-node-version-windows
  *
+ * Copyright (c) 2016 Connor Uhlman
+ * Licensed under the MIT license.
+ *
  * Fork of grunt-node-version
  * https://github.com/jking90/grunt-node-version
- * Copyright (c) 2013 Jimmy King
- * Licensed under the MIT license.
  */
 
  "use strict";

src/nvm.js

@@ -1,10 +1,11 @@
 /*
  * grunt-node-version-windows
  *
+ * Copyright (c) 2016 Connor Uhlman
+ * Licensed under the MIT license.
+ *
  * Fork of grunt-node-version
  * https://github.com/jking90/grunt-node-version
- * Copyright (c) 2013 Jimmy King
- * Licensed under the MIT license.
  */
 
  "use strict";

tasks/node_version.js

@@ -1,10 +1,11 @@
 /*
  * grunt-node-version-windows
  *
+ * Copyright (c) 2016 Connor Uhlman
+ * Licensed under the MIT license.
+ *
  * Fork of grunt-node-version
  * https://github.com/jking90/grunt-node-version
- * Copyright (c) 2013 Jimmy King
- * Licensed under the MIT license.
  */
 
 "use strict";