Skip to content

Commit 723fbc8

Browse files
committed
Fix: README.md
1 parent 9f5b0ed commit 723fbc8

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,53 @@ Provides an extension for detecting slow tests in [`phpunit/phpunit`](https://gi
1616

1717
## Installation
1818

19+
### Composer
20+
1921
Run
2022

2123
```sh
2224
composer require --dev ergebnis/phpunit-slow-test-detector
2325
```
2426

27+
to install `ergebnis/phpunit-slow-test-detector` as a composer package.
28+
29+
### Phar
30+
31+
Download `phpunit-slow-test-detector.phar` from the [latest release](https://github.com/ergebnis/phpunit-slow-test-detector/releases/latest).
32+
2533
## Usage
2634

27-
### Bootstrapping the extension
35+
### Bootstrapping the extension as a composer package
36+
37+
To bootstrap the extension as a composer package, adjust your `phpunit.xml` configuration file:
38+
39+
```diff
40+
<phpunit
41+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
42+
xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
43+
bootstrap="vendor/autoload.php"
44+
>
45+
+ <extensions>
46+
+ <bootstrap class="Ergebnis\PHPUnit\SlowTestDetector\Extension"/>
47+
+ </extensions>
48+
<testsuites>
49+
<testsuite name="unit">
50+
<directory>test/Unit/</directory>
51+
</testsuite>
52+
</testsuites>
53+
</phpunit>
54+
```
55+
56+
### Bootstrapping the extension as a PHAR
2857

29-
To bootstrap the extension, adjust your `phpunit.xml` configuration file:
58+
To bootstrap the extension as a PHAR, adjust your `phpunit.xml` configuration file and configure the `extensionsDirectory` attribute of the `<phpunit>` element:
3059

3160
```diff
3261
<phpunit
3362
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3463
xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
3564
bootstrap="vendor/autoload.php"
65+
+ extensionsDirectory="directory/where/you/saved/the/extension/phars"
3666
>
3767
+ <extensions>
3868
+ <bootstrap class="Ergebnis\PHPUnit\SlowTestDetector\Extension"/>

0 commit comments

Comments
 (0)