Update README.md

bmitch · Jun 19, 2017 · fff54db · fff54db
1 parent b2ee71b
commit fff54db
Showing 1 changed file with 29 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # churn-php
-Help discover good candidates for refactoring
+Helps discover good candidates for refactoring.
 
 [![Build Status](https://travis-ci.org/bmitch/churn-php.svg?branch=master)](https://travis-ci.org/bmitch/churn-php) [![codecov](https://codecov.io/gh/bmitch/churn-php/branch/master/graph/badge.svg)](https://codecov.io/gh/bmitch/churn-php) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/bmitch/churn-php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/bmitch/churn-php/?branch=master) [![Code Climate](https://codeclimate.com/github/bmitch/churn-php/badges/gpa.svg)](https://codeclimate.com/github/bmitch/churn-php) [![Packagist](https://img.shields.io/packagist/v/bmitch/churn-php.svg)]() [![Packagist](https://img.shields.io/packagist/l/bmitch/churn-php.svg)]()
 ----------
@@ -13,10 +13,36 @@ Help discover good candidates for refactoring
 * [License](#license)
 
 ## What is it? ##
+`churn-php` is a package that helps you identify files in your project that could be good candidates for refactoring. It examines each PHP file in the path it is provided and:
+* Checks how many commits it has.
+* Calculates the cyclomatic complexity.
+* Creates a score based on these two values.
+
+The results are displayed in a table:
+```
++---------------------------------------------------------------------+---------------+------------+-------+
+| File                                                                | Times Changed | Complexity | Score |
++---------------------------------------------------------------------+---------------+------------+-------+
+| src/Assessors/CyclomaticComplexity/CyclomaticComplexityAssessor.php | 4             | 4          | 8     |
+| src/Assessors/GitCommitCount/GitCommitCountAssessor.php             | 3             | 4          | 7     |
+| src/Commands/ChurnCommand.php                                       | 3             | 2          | 5     |
+| src/Managers/FileManager.php                                        | 2             | 3          | 5     |
+| src/Results/ResultsGenerator.php                                    | 2             | 2          | 4     |
+| src/Results/Result.php                                              | 2             | 1          | 3     |
+| src/Services/CommandService.php                                     | 2             | 1          | 3     |
+| src/Results/ResultCollection.php                                    | 1             | 1          | 2     |
++---------------------------------------------------------------------+---------------+------------+-------+
+```
+
+
+A file that changes a lot and has a high complexity might be a higher candidate for refactoring than a file that doesn't change a lot and has a low complexity.
+
+`churn-php` only intends to assist the developer identifying files for refactoring. It's best to use the results in addition to your own judgement to decide which files you may want to refactor.
+
 ## Compatiblity ##
+* PHP 7+
 
 ## How to Install? ##
-
 Install via Composer:
 ```
 composer require bmitch/churn-php --dev
@@ -25,6 +51,7 @@ composer require bmitch/churn-php --dev
 ## How to Use? ##
 ```
 vendor/bin/churn run <path to source code>
+
 ```
 ## Similar Packages
 * https://github.com/danmayer/churn (Ruby)
@@ -33,5 +60,4 @@ vendor/bin/churn run <path to source code>
 Please see [CONTRIBUTING.md](CONTRIBUTING.md)
 
 ## License ##
-
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.