Chris@0: [![Latest Stable Version](https://poser.pugx.org/phpunit/php-code-coverage/v/stable.png)](https://packagist.org/packages/phpunit/php-code-coverage)
Chris@14: [![Build Status](https://travis-ci.org/sebastianbergmann/php-code-coverage.svg?branch=5.3)](https://travis-ci.org/sebastianbergmann/php-code-coverage)
Chris@0: 
Chris@14: # SebastianBergmann\CodeCoverage
Chris@0: 
Chris@14: **SebastianBergmann\CodeCoverage** is a library that provides collection, processing, and rendering functionality for PHP code coverage information.
Chris@0: 
Chris@0: ## Installation
Chris@0: 
Chris@14: You can add this library as a local, per-project dependency to your project using [Composer](https://getcomposer.org/):
Chris@0: 
Chris@14:     composer require phpunit/php-code-coverage
Chris@0: 
Chris@14: If you only need this library during development, for instance to run your project's test suite, then you should add it as a development-time dependency:
Chris@14: 
Chris@14:     composer require --dev phpunit/php-code-coverage
Chris@14: 
Chris@14: ## Using the SebastianBergmann\CodeCoverage API
Chris@0: 
Chris@0: ```php
Chris@0: <?php
Chris@14: use SebastianBergmann\CodeCoverage\CodeCoverage;
Chris@14: 
Chris@14: $coverage = new CodeCoverage;
Chris@14: 
Chris@14: $coverage->filter()->addDirectoryToWhitelist('/path/to/src');
Chris@14: 
Chris@0: $coverage->start('<name of test>');
Chris@0: 
Chris@0: // ...
Chris@0: 
Chris@0: $coverage->stop();
Chris@0: 
Chris@14: $writer = new \SebastianBergmann\CodeCoverage\Report\Clover;
Chris@0: $writer->process($coverage, '/tmp/clover.xml');
Chris@0: 
Chris@14: $writer = new \SebastianBergmann\CodeCoverage\Report\Html\Facade;
Chris@0: $writer->process($coverage, '/tmp/code-coverage-report');
Chris@0: ```
Chris@14: