Add overview section and separate init and analyze commands

Author: jmolivas

README.md

@@ -1,59 +1,64 @@
+PHPQA
+=============================================
+PHPQA Analyzer CLI tool
+
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-- [PHPQA](#phpqa)
-  - [Based on:](#based-on)
-  - [Install Stand Alone](#install-stand-alone)
-    - [Clone project](#clone-project)
-    - [Install dependencies](#install-dependencies)
-    - [Create symbolink link](#create-symbolink-link)
-  - [Include in your project](#include-in-your-project)
-  - [How to run this project](#how-to-run-this-project)
+- [Overview](#overview)
+- [Install Stand Alone](#install-stand-alone)
+  - [Clone project](#clone-project)
+  - [Install dependencies](#install-dependencies)
+  - [Create symbolink link](#create-symbolink-link)
+- [Include in your project](#include-in-your-project)
+- [How to run this project](#how-to-run-this-project)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-PHPQA
-=============================================
-PHPQA Analyzer CLI tool
+## Overview
+This project aims to serve as a CLI tool to unify the use of different PHP tools related to Quality Assurance and code analysis in PHP.
 
-## Based on:  
-http://carlosbuenosvinos.com/write-your-git-hooks-in-php-and-keep-them-under-git-control/  
-http://phpqatools.org/  
+Every analyzer tool handles arguments and options using different formats, the goal of this project is to provide and single way to interact with those projects, you can also set options and arguments using the default configuration file the project supports.
 
-## Install Stand Alone
+> This project was originally developed as part of [Drupal Console](https://github.com/hechoendrupal/DrupalConsole) and based on the blog post [Write your git hooks in PHP and keep them under git control](http://carlosbuenosvinos.com/write-your-git-hooks-in-php-and-keep-them-under-git-control/).
 
-### Clone project
+## Install
 
-```
+### Cloning the project
+```bash
 $ cd ~
 $ git clone git@github.com:jmolivas/phpqa.git
-```
-
-### Install dependencies 
-
-```
 $ cd phpqa
+# download dependencies
 $ composer install
+# make phpqa globally accessible creating a symlink 
+$ ln -s ~/phpqa/bin/phpqa.php /usr/local/bin/phpqa
 ```
 
-### Create symbolink link
-
-```
-ln -s ~/phpqa/bin/phpqa.php /usr/local/bin/phpqa
+## Using Composer
+```bash
+$ composer global require jmolivas/phpqa
+# Make sure you add ~/.composer/vendor/bin/ to your PATH.
 ```
 
-## Include in your project
-```
-$ composer require jmolivas/phpqa
-```
+## Usage
 
-## How to run this project
+### Copy configuration files to user home directory 
 ```
-# Make sure you run this command the first time  
 $ phpqa init
+```
 
-# Run this command to test your project code
-$ phpqa analyze --project=php --files=src/ 
+### Analyze a project
+``` 
+$ cd to/project/path
+$ phpqa analyze --project=PROJECT --files[=FILES] 
 ```
 
-> Note: This project is a work-in-progress need some love related to code clean up and testing coverage.
+**Options:**
+
+| Option  | Description | 
+| ------- | ----------------------------- |  
+| project | Available default values php, symfony and drupal |
+| files   | If this option is not set then the files added to git index will be scanned. This is useful when setting executing this tool on a git-hook pre-commit. |    
+
+> Note: This project is a work-in-progress and need some love related to code clean up and testing coverage.