From 3e376e4713cbc55197276c8cd99fd29924f28054 Mon Sep 17 00:00:00 2001 From: Sebastian Bergmann Date: Fri, 3 Feb 2017 10:17:04 +0100 Subject: [PATCH] Update documentation --- README.md | 26 +++++++++----------------- 1 file changed, 9 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index c9e9089..00ee405 100644 --- a/README.md +++ b/README.md @@ -6,32 +6,24 @@ ### PHP Archive (PHAR) -The easiest way to obtain PHPCOV is to download a [PHP Archive (PHAR)](http://php.net/phar) that has all required dependencies of PHPCOV bundled in a single file: +The easiest way to obtain phpcov is to download a [PHP Archive (PHAR)](http://php.net/phar) that has all required dependencies of phpcov bundled in a single file: - wget https://phar.phpunit.de/phpcov.phar - chmod +x phpcov.phar - mv phpcov.phar /usr/local/bin/phpcov + $ wget https://phar.phpunit.de/phpcov.phar + $ chmod +x phpcov.phar + $ mv phpcov.phar /usr/local/bin/phpcov You can also immediately use the PHAR after you have downloaded it, of course: - wget https://phar.phpunit.de/phpcov.phar - php phpcov.phar + $ wget https://phar.phpunit.de/phpcov.phar + $ php phpcpd.phar ### Composer -Simply add a dependency on `phpunit/phpcov` to your project's `composer.json` file if you use [Composer](http://getcomposer.org/) to manage the dependencies of your project. Here is a minimal example of a `composer.json` file that just defines a development-time dependency on PHPCOV: +You can add this tool as a local, per-project, development-time dependency to your project using [Composer](https://getcomposer.org/): - { - "require-dev": { - "phpunit/phpcov": "*" - } - } + $ composer require --dev phpunit/phpcov -For a system-wide installation via Composer, you can run: - - composer global require 'phpunit/phpcov=*' - -Make sure you have `~/.composer/vendor/bin/` in your path. +You can then invoke it using the `vendor/bin/phpcov` executable. ## Usage