Documentation and configuration cleanup. (#33)

* Documentation and configuration cleanup.

* Updating with global instructions.

* Code review feedback.

Author: fluxsauce

.gitignore

@@ -1 +1,61 @@
-node_modules
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next

README.md

@@ -1,19 +1,29 @@
 # why-is-node-running
 
-Node is running but you don't know why? why-is-node-running is here to help you.
+Node is running but you don't know why? `why-is-node-running` is here to help you.
 
+## Installation
+
+Node 8 and above:
+
+```bash
+npm i why-is-node-running -g
 ```
-$ npm install why-is-node-running
+
+Earlier Node versions (no longer supported):
+
+```bash
+npm i why-is-node-running@v1.x -g
 ```
 
 ## Usage
 
-``` js
-var log = require('why-is-node-running') // should be your first require
-var net = require('net')
+```js
+const log = require('why-is-node-running') // should be your first require
+const net = require('net')
 
 function createServer () {
-  var server = net.createServer()
+  const server = net.createServer()
   setInterval(function () {}, 1000)
   server.listen(0)
 }
@@ -26,7 +36,13 @@ setTimeout(function () {
 }, 100)
 ```
 
-Run the above script like this: `node example.js`. It will print the following:
+Save the file as `example.js`, then execute:
+
+```bash
+node ./example.js
+```
+
+Here's the output:
 
 ```
 There are 5 handle(s) keeping the process running
@@ -53,22 +69,21 @@ There are 5 handle(s) keeping the process running
 
 ## CLI
 
-You can also run `why-is-node-running` standalone if you don't want to include it inside your code. Sending `SIGUSR1` signal to the process will produce the log.
+You can also run `why-is-node-running` as a standalone if you don't want to include it inside your code. Sending `SIGUSR1` signal to the process will produce the log.
 
-```
-$ npm install why-is-node-running -g
+```bash
+why-is-node-running /path/to/some/file.js
 ```
 
 ```
-$ why-is-node-running /path/to/some/file.js
 probing module /path/to/some/file.js
 kill -SIGUSR1 31115 for logging
 ```
 
-To trigger the log do:
+To trigger the log:
 
 ```
-$ kill -SIGUSR1 31115
+kill -SIGUSR1 31115
 ```
 
 ## License

package.json

@@ -9,6 +9,9 @@
   "bin": {
     "why-is-node-running": "cli.js"
   },
+  "engines": {
+    "node": ">=8"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/mafintosh/why-is-node-running.git"
@@ -21,6 +24,12 @@
     "handles"
   ],
   "author": "Mathias Buus (@mafintosh)",
+  "contributors": [
+    {
+      "name": "Jon Peck",
+      "email": "jpeck@fluxsauce.com"
+    }
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/mafintosh/why-is-node-running/issues"