Skip to content

Commit 3567929

Browse files
authored
Minor tweaks to the README.md file
1 parent 2ff8f4a commit 3567929

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# PHP Composter PHPCS WPCS
22

3-
### Check your PHP source code for compliance with WordPress coding standards before committing.
3+
### Check your PHP source code for compliance with WordPress Coding Standards before committing.
44

5-
This Composer package will start to check your PHP files upon each commit to make sure they comply to the [WordPress Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/).
5+
This Composer package will start to check your PHP files upon each commit to make sure they comply with the [WordPress Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/).
66

77
This is a [PHP Composter](https://github.com/php-composter/php-composter) Action.
88

@@ -16,7 +16,7 @@ Uses the wonderful [PHP CodeSniffer Project](https://github.com/squizlabs/PHP_Co
1616

1717
## Installation
1818

19-
Add the repository's URL as a repository to the `composer.json` file:
19+
Add the GitHub repository's URL as a package repository to the `composer.json` file:
2020
```
2121
"repositories": [
2222
{
@@ -26,7 +26,7 @@ Add the repository's URL as a repository to the `composer.json` file:
2626
],
2727
```
2828

29-
Then j add as a development requirement to your `composer.json`, and it should work automagically:
29+
Then just add the package as a development requirement to your `composer.json`, and it should work automagically:
3030

3131
```BASH
3232
composer require --dev php-composter/php-composter-phpcs-wpcs
@@ -38,9 +38,9 @@ It should just work when you `git commit`.
3838

3939
## Internals
4040

41-
By default of the 5 different WordPress coding standards (`WordPress-VIP`, `WordPress`, `WordPress-Extra`, `WordPress-Docs` and `WordPress-Core`), this one uses the WordPress-Extra.
41+
By default, of the 5 different WordPress coding standards (`WordPress-VIP`, `WordPress`, `WordPress-Extra`, `WordPress-Docs` and `WordPress-Core`), this one uses the `WordPress-Extra` one.
4242

43-
If you need to change it, currently you need to edit the Sniff file. Contributions on how to make this dynamic are welcome (.env file, different sniffs for each and choosing the appropriate hooks).
43+
If you need to change it, currently you need to edit the Sniff file. Contributions on how to make this dynamic are welcome (`.env` file, different sniffs for each and choosing the appropriate hooks).
4444

4545
## Contributing
4646

0 commit comments

Comments
 (0)