Skip to content

Commit c0ffcbd

Browse files
committed
Add configuration example
1 parent 2dfd1d4 commit c0ffcbd

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
11
# Rector plugin for phpcq
22

33
This plugin provides [rector](https://github.com/rectorphp/rector) integration for phpcq.
4+
5+
## Configuration
6+
7+
Extend your `.phpcq.yaml.dist` configuration by adding the plugin and configuring the task:
8+
9+
```yaml
10+
phpcq:
11+
plugins:
12+
version: ^1.0
13+
signed: false
14+
15+
tasks:
16+
rector:
17+
config:
18+
# Set to
19+
dry-run: false
20+
# Custom config file, defaults to rector.php
21+
config: custom-rector.php
22+
```

0 commit comments

Comments
 (0)