Skip to content

Commit c2eca1d

Browse files
authored
Update README.md
1 parent abf1e12 commit c2eca1d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,19 @@ Turns [checkstyle based XML-Reports](https://github.com/FriendsOfPHP/PHP-CS-Fixe
66

77
![PHPUnit Action Matcher Context Example](https://github.com/mheap/phpunit-github-actions-printer/blob/master/phpunit-printer-context.png?raw=true)
88

9+
# Installation
10+
11+
Install the binary via composer
12+
`composer require staabm/annotate-pull-request-from-checkstyle`
913

1014
# Example Usage
1115

16+
## Process a checkstyle formated file
17+
18+
`vendor/bin/cs2pr /path/to/checkstyle-report.xml`
19+
20+
## Pipe the output of another commmand
21+
1222
`phpstan analyse --no-progress --error-format=checkstyle | vendor/bin/cs2pr`
1323

1424
`psalm --output-format=checkstyle | vendor/bin/cs2pr`
@@ -18,3 +28,5 @@ Turns [checkstyle based XML-Reports](https://github.com/FriendsOfPHP/PHP-CS-Fixe
1828
# Idea
1929

2030
This script is based on a suggestion of [Benjamin Eberlei](https://twitter.com/beberlei/status/1218970454557372416)
31+
32+
The Code is inspired by https://github.com/mheap/phpunit-github-actions-printer

0 commit comments

Comments
 (0)