Skip to content

Commit fd522a3

Browse files
authored
Fixed typos (#43)
1 parent c50c72b commit fd522a3

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
[![Continuous Integration](https://github.com/staabm/annotate-pull-request-from-checkstyle/workflows/Continuous%20Integration/badge.svg)](https://github.com/staabm/annotate-pull-request-from-checkstyle/actions)
44
[![Continuous Deployment](https://github.com/staabm/annotate-pull-request-from-checkstyle/workflows/Continuous%20Deployment/badge.svg)](https://github.com/staabm/annotate-pull-request-from-checkstyle/actions)
55

6-
Turns [checkstyle based XML-Reports](https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/master/doc/checkstyle.xsd) into Github Pull Request [Annotations via the Checks API](https://developer.github.com/v3/checks/).
7-
This script is meant for use within your GithubAction.
6+
Turns [checkstyle based XML-Reports](https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/master/doc/checkstyle.xsd) into GitHub Pull Request [Annotations via the Checks API](https://developer.github.com/v3/checks/).
7+
This script is meant for use within your GitHub Action.
88

9-
That means you no longer search thru your GithubAction logfiles.
9+
That means you no longer search thru your GitHub Action logfiles.
1010
No need to interpret messages which are formatted differently with every tool.
1111
Instead you can focus on your Pull Request, and you don't need to leave the Pull Request area.
1212

@@ -26,7 +26,7 @@ composer require staabm/annotate-pull-request-from-checkstyle
2626

2727
`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.
2828

29-
Run one of the following commands within your GithubAction workflow:
29+
Run one of the following commands within your GitHub Action workflow:
3030

3131
## Process a checkstyle formatted file
3232

@@ -37,7 +37,7 @@ vendor/bin/cs2pr /path/to/checkstyle-report.xml
3737
### Available Options
3838

3939
- `--graceful-warnings`: Don't exit with error codes if there are only warnings
40-
- `--colorize`: Colorize the output. Useful if the same lint script should be used locally on the command line and remote on Github Actions. With this option, errors and warnings are better distinguishable on the command line and the output is still compatible with Github Annotations
40+
- `--colorize`: Colorize the output. Useful if the same lint script should be used locally on the command line and remote on GitHub Actions. With this option, errors and warnings are better distinguishable on the command line and the output is still compatible with GitHub Annotations
4141

4242

4343
## Pipe the output of another commmand

0 commit comments

Comments
 (0)