Skip to content

Commit

Permalink
Add configuration example
Browse files Browse the repository at this point in the history
  • Loading branch information
dmolineus committed Apr 5, 2024
1 parent 2dfd1d4 commit c0ffcbd
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
# Rector plugin for phpcq

This plugin provides [rector](https://github.com/rectorphp/rector) integration for phpcq.

## Configuration

Extend your `.phpcq.yaml.dist` configuration by adding the plugin and configuring the task:

```yaml
phpcq:
plugins:
version: ^1.0
signed: false

tasks:
rector:
config:
# Set to
dry-run: false
# Custom config file, defaults to rector.php
config: custom-rector.php
```

0 comments on commit c0ffcbd

Please sign in to comment.