Skip to content

Commit 9437962

Browse files
committed
Switching PHPCS and SVN config sections in the Configuration section + minor language improvements
1 parent 6f4146d commit 9437962

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,15 @@ if ( defined( 'WP_CLI' ) && WP_CLI ) {
2626

2727
# Configuration
2828

29-
This project still requires some manual updates to the code in order to make it working.
29+
This project requires some manual updates to the code in order to make it working.
30+
31+
## PHPCS
32+
33+
If default values for running PHPCS command does not match your environment (see https://github.com/Automattic/phpcs-diff/blob/master/class-phpcs-diff.php#L5 ), you either need to hardcode them to the `PHPCS_Diff` class, or pass those in the `(array) $options` param to class' constructor from the WP CLI command - https://github.com/Automattic/phpcs-diff/blob/master/wp-cli-command.php#L64
34+
35+
```
36+
new PHPCS_Diff( new PHPCS_Diff_SVN( $repo ), array( 'phpcs_command' => 'my_phpcs_command', 'standards_location' => 'my/standards/location' ) );
37+
```
3038

3139
## SVN
3240

@@ -46,15 +54,7 @@ You'll have to either register your repository in the `PHPCS_Diff_SVN`'s constru
4654
new PHPCS_Diff_SVN( $repo, array( 'repo_url' => 'https://plugins.svn.wordpress.org/hello-dolly' ) );
4755
```
4856

49-
## PHPCS
50-
51-
If default values for running PHPCS command does not match your environment (see https://github.com/Automattic/phpcs-diff/blob/master/class-phpcs-diff.php#L5 ), you either need to hardcode them to the `PHPCS_Diff` class, or pass those in the `(array) $options` param to class' constructor from the WP CLI command - https://github.com/Automattic/phpcs-diff/blob/master/wp-cli-command.php#L64
52-
53-
```
54-
new PHPCS_Diff( new PHPCS_Diff_SVN( $repo ), array( 'phpcs_command' => 'my_phpcs_command', 'standards_location' => 'my/standards/location' ) );
55-
```
56-
57-
# Running the command
57+
# Running the WP CLI command
5858

5959
Example command run:
6060

0 commit comments

Comments
 (0)