Skip to content

Commit 6973b51

Browse files
committed
Improving language in README.md and adding examples of WP CLI command updates for SVN and PHPCS configuration
1 parent 5959470 commit 6973b51

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,18 @@ This project still requires some manual updates to the code in order to make it
2626

2727
You either need to hardcode SVN credentials to `PHPCS_Diff_SVN` class ( related code: https://github.com/Automattic/phpcs-diff/blob/master/class-phpcs-diff-svn.php#L5 ) or pass those via 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
2828

29+
```
30+
new PHPCS_Diff_SVN( $repo, array( 'svn_username' => 'my_username', 'svn_password' => 'my_password' ) );
31+
```
32+
2933
## PHPCS
3034

3135
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
3236

37+
```
38+
new PHPCS_Diff( new PHPCS_Diff_SVN( $repo ), array( 'phpcs_command' => 'my_phpcs_command', 'standards_location' => 'my/standards/location' ) );
39+
```
40+
3341
# Running the command
3442

3543
Example command run:
@@ -42,7 +50,7 @@ For more params of the command, please, see the code directly: https://github.co
4250

4351
# TODO:
4452

45-
- [ ] Make configuration of the environment (phpcs command, standard's location, more repositories registration and svn credentials) easier than manually modificating the code
53+
- [ ] Make configuration of the environment (phpcs command, standard's location, more repositories registration and svn credentials) easier than manual modification of the code
4654
- [ ] Create GitHub version control backend
4755
- [ ] Make the WP CLI command version control backend agnostic
4856
- [ ] Turn this into a proper WordPress plugin for easy installation

0 commit comments

Comments
 (0)