Skip to content
This repository has been archived by the owner on Sep 9, 2022. It is now read-only.

Commit

Permalink
docs changes
Browse files Browse the repository at this point in the history
  • Loading branch information
chekalsky committed Jan 16, 2020
1 parent 0fc7c3a commit d69478c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# PHP CodeSniffer GitHub Action

This action will help you to run phpcs (PHP_CodeSniffer) with [GitHub Actions](https://github.com/features/actions) platform. It also supports [annotations](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-status-checks#checks) out of the box — you don't need to use any tokens to make it work.
This action will help you to run phpcs (PHP_CodeSniffer) with [GitHub Actions](https://github.com/features/actions) platform. It also supports [annotations](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-status-checks#checks) out of the box — you don't need to use any tokens to make it work.

<img src="https://leonardo.osnova.io/491e4ce9-72d9-9417-29f7-9934ce7ec8ad/" title="How Annotations Works" width="560" height="432" />
<img src="https://leonardo.osnova.io/491e4ce9-72d9-9417-29f7-9934ce7ec8ad/" alt="How Annotations Works" title="How Annotations Works" width="560" height="432" />

## Usage

Expand All @@ -20,15 +20,15 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: PHPCS check
uses: chekalsky/phpcs-action:v1
uses: chekalsky/phpcs-action@v1
```
Eventually you could also check for warnings.
```yaml
...
- name: PHPCS check
uses: chekalsky/phpcs-action:v1
uses: chekalsky/phpcs-action@v1
with:
enable_warnings: true
```
Expand Down

0 comments on commit d69478c

Please sign in to comment.