Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shalior committed Jun 3, 2022
1 parent 33078e2 commit 3dbbfd8
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# WordPress PHP Code Sniffer GitHub action
## PHP Code Sniffer GitHub action
### Run and fix errors

[![release](https://github.com/shalior/wordpress-phpcs-action/workflows/release/badge.svg)](https://github.com/shalior/action-phpcs-wordpress/actions?query=workflow%3Arelease)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/shalior/wordpress-phpcs-action?logo=github&sort=semver)](https://github.com/shalior/action-phpcs-wordpress/releases)

- **Works on every PHP code base**, including **WordPress**(all rules are bundled).
- Supports configuration files (`phpcs.xml`, `phpcs.xml.dist`, ...).
- Fixes all fixable errors.

This action runs PHPCS and fix errors using PHPCBF. If the errors are not fixable the job will fail, if they are phpcbf will fix them.
The WordPress rulesets are bundled and made available to `phpcs`. The action supports using PHPCS configuration files if there is a `phpcs.xml` or other supported file names.

Expand Down

0 comments on commit 3dbbfd8

Please sign in to comment.