From 9206393e339087155287dd622f403019856b2ebe Mon Sep 17 00:00:00 2001 From: Rafael Dohms Date: Wed, 12 Nov 2014 14:26:23 -0500 Subject: [PATCH] Update README.md Updated your install instructions to use the recommended `composer require` command which avoids manually editing the json file and also runs install/update automatically for the new requirement, making it all happen in a single step. It also automatically finds the proper latest version. I also added instructions for using dev-master, but i highly recommend tagging releases often. Feel free to ask me questions about this and the how and why it works. --- README.md | 25 ++++++------------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index a1b1145..683a699 100644 --- a/README.md +++ b/README.md @@ -15,29 +15,16 @@ This package requires a user, but not necessarily a paid account, on Code Climate, so if you don't have one the first step is to signup at: https://codeclimate.com. -To install php-test-reporter with Composer first add the following to -your composer.json file: +To install php-test-reporter with Composer run the following command. -**composer.json** - -```javascript -{ - "require-dev": { - "codeclimate/php-test-reporter": "dev-master" - } -} -``` - -Then, run: - -``` -$ php composer.phar install --dev +```shell +composer require codeclimate/php-test-reporter --dev ``` -If adding the test-reporter to an existing project, run: +This will get you the latest version of the reporter and install it. If you do want the master, untagged, version you may use the command below: -``` -$ php composer.phar update codeclimate/php-test-reporter --dev +```shell +composer require codeclimate/php-test-reporter:@dev --dev ``` ## Usage