Merge pull request #27 from ibarsi/develop

Develop

.eslintignore

@@ -0,0 +1,3 @@
+**/.git/**/*
+**/node_modules/**/*
+**/dist/**/*

.eslintrc

@@ -0,0 +1,34 @@
+{
+    "parser": "babel-eslint",
+
+    "env": {
+        "browser": true,     // browser global variables.
+        "node": true,        // Node.js global variables and Node.js-specific rules.
+        "mocha": true,       // adds all of the Mocha testing global variables.
+        "es6": true          // enable es6 keywords, except module.
+    },
+
+    "plugins": [
+        "flowtype"
+    ],
+
+    "extends": [
+        "eslint:recommended",
+        "plugin:flowtype/recommended"
+    ],
+
+    "parserOptions": {
+        "sourceType": "module"
+    },
+
+    "settings": {
+        "flowtype": {
+            "onlyFilesWithFlowAnnotation": false
+        }
+    },
+
+    "rules": {
+        // GENERAL
+        "no-console": 0
+    }
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Igor Barsi
+
+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 the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -9,6 +9,20 @@
 When invoked, the tool reads your current directory (looking for `package.json`) and attempts to "guess" reasonable defaults for the repository you're wanting to analyze, accepting user input for overrides.
 Once configured, a dashboard is displayed (courtesy of [blessed-contrib](https://github.com/yaronn/blessed-contrib)) with useful metrics regarding your repository's commit velocity.
 
+## Install
+
+```
+npm install -g git-velocity
+```
+
+## Usage
+
+Navigate to the root directory of the repo you wish to analyze and run the following:
+
+```
+git-velocity
+```
+
 Currently, the following tiles are displayed on the dashboard:
 
 ### INFO
@@ -23,7 +37,7 @@ Simple markdown-supported text area, introducing you to the dashboard, listing s
 
 A layered line graph, comparing previous vs current commits. Length of time compared depends on how the dashboard was configured when the tool was invoked.
 
-## GETTING STARTED ##
+## GETTING STARTED
 
 After cloning and installing dependencies via `npm install`, you're basically all set and ready to go.
 The solution was built using many new language features that were not implemented during the time, and as such transpilation (via Babel) is required.

package.json

@@ -25,7 +25,7 @@
     "start": "node dist/index.js"
   },
   "author": "ibarsi",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/ibarsi/git-velocity/issues"
   },