diff --git a/README.md b/README.md index f1a64e7..4ce0946 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ + + + +- [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) + + + PHPQA ============================================= PHPQA Analyzer CLI tool @@ -6,7 +19,30 @@ PHPQA Analyzer CLI tool http://carlosbuenosvinos.com/write-your-git-hooks-in-php-and-keep-them-under-git-control/ http://phpqatools.org/ -## How to use +## Install Stand Alone + +### Clone project + +``` +$ cd ~ +$ git clone git@github.com:jmolivas/phpqa.git +``` + +### Install dependencies + +``` +$ cd phpqa +$ composer install +``` + +### Create symbolink link + +``` +ln -s ~/phpqa/bin/phpqa.php /usr/local/bin/phpqa +``` + + +## Include in your project ``` $ composer require jmolivas/phpqa ``` \ No newline at end of file