Skip to content

Commit a6e92cf

Browse files
author
Steffen Giers
committed
docs: add config.php example
1 parent 1a78cb3 commit a6e92cf

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,17 @@ git submodule add https://github.com/gearsdigital/kirby-reporter.git site/plugin
4848
| --- | --- |
4949
| `kirby-reporter.repository` | The repository to which the issues are reported.<br>*Must be a fully qualified url:* `https://github.com/gearsdigital/kirby-reporter`|
5050
| `kirby-reporter.token` | Your personal access token.<br>*Your personal access token is never populated to the client!* |
51-
| `kirby-reporter.disabled` | Setting this option to `true` disables the plugin completely. |
51+
| `kirby-reporter.disabled` | Setting this option to `true` disables the plugin completely. This option *must* be present. |
52+
53+
### Example
54+
```php
55+
// site/config/config.php
56+
return [
57+
'kirby-reporter.disabled' => false, // set true to disable the plugin
58+
'kirby-reporter.repository' => 'https://github.com/gearsdigital/kirby-reporter',
59+
'kirby-reporter.token' => 'c56658e7c03a5995e2e1491e6a3b93fcde6225c9'
60+
];
61+
```
5262

5363
## Configuration
5464

0 commit comments

Comments
 (0)