Skip to content

Commit 09d410a

Browse files
updated README.md to contain instructions for customizing markers
1 parent aaa7543 commit 09d410a

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ If you are using PHP 7.0.x, you will need to use a compatible version of PHPUnit
1818
```bash
1919
composer require --dev codedungeon/phpunit-result-printer:^0.8
2020
```
21+
### Usage
2122

2223
To activate the Printer for PHPUnit, just add it to your configuration XML:
2324

@@ -33,6 +34,19 @@ Or from Command-Line:
3334
```bash
3435
phpunit --printer=Codedungeon\\PHPUnitPrettyResultPrinter\\Printer
3536
```
37+
#### Customizing Markers
38+
You can customize the markers which are used for `success`, `fail`, `error`, `skipped`, `incomplete` by modifying the `phpunit-printer.yml` file.
39+
- Create a `phpunit-printer.yml` file in your application root to override default
40+
41+
The following are the default markers used (from the package `phpunit-printer.yml` file)
42+
```
43+
markers:
44+
cd-pass: "✓"
45+
cd-fail: "✖"
46+
cd-error: "⚈"
47+
cd-skipped: "→"
48+
cd-incomplete: "∅ "
49+
```
3650

3751
### License
3852

0 commit comments

Comments
 (0)