Docs: Improve documentation and comments

Author: Tyler Kellen

README.md

@@ -5,19 +5,21 @@
 
 ## What is it?
 
-Say you wrote a command line tool that runs arbitrary javascript (e.g. task runner, test framework, etc). Now, say you want to support running it with v8 flags enabled (`--harmony`, for example).
+Say you wrote a command line tool that runs arbitrary javascript (e.g. task runner, test framework, etc). For the sake of discussion, let's pretend it's a testing harness you've named `testify`.
 
-For example, let's run an imaginary testing tool with the following command: `test --harmony spec tests.js`. This would produce a [`process.argv`](http://nodejs.org/docs/latest/api/process.html#process_process_argv) of:
+Everything is going splendidly until one day you decide to test some code that relies on a feature behind a v8 flag in node (`--harmony`, for example).  Without much thought, you run `testify --harmony spec tests.js`.
+
+It doesn't work. After digging around for a bit, you realize this produces a [`process.argv`](http://nodejs.org/docs/latest/api/process.html#process_process_argv) of:
 
 `['node', '/usr/local/bin/test', '--harmony', 'spec', 'tests.js']`
 
-The `--harmony` flag is in the wrong place! It needs to be a part of the **node** command. What we actually wanted was:
+Crap. The `--harmony` flag is in the wrong place! It should be applied to the **node** command, not our binary. What we actually wanted was this:
 
 `['node', '--harmony', '/usr/local/bin/test', 'spec', 'tests.js']`
 
-Good news, flaggedRespawn does exactly this. All it takes it a simple conditional in your cli code:
+Flagged-respawn solves this problem.
 
-## Example
+## Sample Usage
 ```js
 #!/usr/bin/env node
 
@@ -26,14 +28,17 @@ const flaggedRespawn = require('flagged-respawn');
 // get a list of all possible v8 flags to intercept
 const v8flags = require('v8flags').fetch();
 
-// if necessary, respawn to apply node flags
+// check to see if any defined flags are in the wrong position
+// if we didn't want to support all v8 flags, we could just as
+// easily do if (!flaggedRespawn.needed(['--harmony'])) instead.
 if (!flaggedRespawn.needed(v8flags)) {
-  // If we are here, no respawn was needed a.k.a no special flags
-  // were seen, or this is the child process that was spawned by
-  // the first run.
+  // If we are here, no special flags were seen, or this
+  // is the child process that our initial run spawned.
   console.log('Running!');
 } else {
-  // respawn so the above branch is entered
+  // if we are here, there are special flags applied to the
+  // wrong command. the above branch will be executed by the
+  // child process this spawns.
   console.log('Respawning...');
   flaggedRespawn.execute(v8flags);
 }
@@ -43,4 +48,4 @@ To see it in action, clone this repository and run `npm install` / `npm run resp
 
 ## Release History
 
-* 2014-09-04 - v0.1.0 - initial release
+* 2014-09-04 - v0.1.1 - initial release

bin/example.js

@@ -5,7 +5,9 @@ const flaggedRespawn = require('../');
 // get a list of all possible v8 flags to intercept
 const v8flags = require('v8flags').fetch();
 
-// if necessary, respawn to apply node flags
+// check to see if any defined flags are in the wrong position
+// if we didn't want to support all v8 flags, we could just as
+// easily do if (!flaggedRespawn.needed(['--harmony'])) instead.
 if (!flaggedRespawn.needed(v8flags)) {
   // If we are here, no respawn was needed a.k.a no special flags
   // were seen, or this is the child process that was spawned by