Merge pull request #13 from renatomefi/fix/general-improvements

Fix/general improvements

Author: adri

.gitignore

@@ -0,0 +1,4 @@
+*.idea*
+*.sublime-*
+**/vendor/*
+coverage/*

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Adrian Philipp, https://github.com/adri <[email protected]>
+Copyright (c) 2013-2016 Adrian Philipp, https://github.com/adri <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

PHPUnit/Util/Log/VCR.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * A TestListener that integrates with PHP-VCR.
  *
@@ -13,7 +14,7 @@
  * @package    PHPUnit
  * @subpackage Util_Log
  * @author     Adrian Philipp <[email protected]>
- * @copyright  2011-2012 Adrian Philipp <[email protected]>
+ * @copyright  2011-2016 Adrian Philipp <[email protected]>
  * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
  * @version    Release: @package_version@
  * @link       http://www.phpunit.de/
@@ -118,6 +119,7 @@ public function addRiskyTest(PHPUnit_Framework_Test $test, Exception $e, $time)
      * A test started.
      *
      * @param PHPUnit_Framework_Test $test
+     * @return bool|null
      */
     public function startTest(PHPUnit_Framework_Test $test)
     {
@@ -171,6 +173,7 @@ private static function parseDocBlock($doc_block, $tag)
 
         return $matches;
     }
+
     /**
      * A test ended.
      *

README.md

@@ -9,7 +9,7 @@ Use `@vcr cassette_name` on your tests to turn VCR automatically on and off.
 
 ## Usage example
 
-``` php
+```php
 class VCRTest extends \PHPUnit_Framework_TestCase
 {
     /**
@@ -26,26 +26,18 @@ class VCRTest extends \PHPUnit_Framework_TestCase
 
 ## Installation
 
-1) Add to your `composer.json`:
+1) Install using composer:
 
-``` json
-    "require-dev": {
-        "php-vcr/phpunit-testlistener-vcr": "*"
-    }
-```
-
-2) Install using composer:
-
-``` bash
+```sh
 composer require --dev php-vcr/phpunit-testlistener-vcr
 ```
 
-3) Add listener to your `phpunit.xml`:
+2) Add listener to your `phpunit.xml`:
 
-``` bash
-   <listeners>
-      <listener class="PHPUnit_Util_Log_VCR" file="vendor/php-vcr/phpunit-testlistener-vcr/PHPUnit/Util/Log/VCR.php" />
-    </listeners>
+```yml
+<listeners>
+    <listener class="PHPUnit_Util_Log_VCR" file="vendor/php-vcr/phpunit-testlistener-vcr/PHPUnit/Util/Log/VCR.php" />
+</listeners>
 ```
 
 ## Dependencies
@@ -59,17 +51,17 @@ PHPUnit-Testlistener-VCR depends on:
 
 In order to run all tests you need to get development dependencies using composer:
 
-``` php
-composer install --dev
-phpunit ./tests
+```php
+composer install
+./vendor/bin/phpunit
 ```
 
 ## Changelog
 
- * 2013-05-14 1.0.0: First prototype
+**The changelog is manage at [PHPUnit testlistener for PHP-VCR releases page](https://github.com/php-vcr/phpunit-testlistener-vcr/releases).**
 
 ## Copyright
-Copyright (c) 2013 Adrian Philipp. Released under the terms of the MIT license. See LICENSE for details.
+Copyright (c) 2013-2016 Adrian Philipp. Released under the terms of the MIT license. See LICENSE for details.
 
 <!--
 name of the projects and all sub-modules and libraries (sometimes they are named different and very confusing to new users)

composer.json

@@ -12,5 +12,8 @@
 
     "require": {
         "php-vcr/php-vcr": "*"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^4.8"
     }
 }