Skip to content

Commit bf22400

Browse files
authored
more descriptions
1 parent 34d27f7 commit bf22400

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,11 @@ composer require staabm/annotate-pull-request-from-checkstyle
2121

2222
# Example Usage
2323

24+
`cs2pr` can be used on a already existing checkstyle-report xml-file. Alternatively you might use it in the unix-pipe notation to chain it into your existing cli command.
25+
2426
Run one of the following commands within your GithubAction workflow:
2527

26-
## Process a checkstyle formated file
28+
## Process a checkstyle formatted file
2729

2830
```bash
2931
vendor/bin/cs2pr /path/to/checkstyle-report.xml

0 commit comments

Comments
 (0)