Skip to content

Commit

Permalink
docs: add config.php example
Browse files Browse the repository at this point in the history
  • Loading branch information
Steffen Giers committed Jan 16, 2020
1 parent 1a78cb3 commit a6e92cf
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,17 @@ git submodule add https://github.com/gearsdigital/kirby-reporter.git site/plugin
| --- | --- |
| `kirby-reporter.repository` | The repository to which the issues are reported.<br>*Must be a fully qualified url:* `https://github.com/gearsdigital/kirby-reporter`|
| `kirby-reporter.token` | Your personal access token.<br>*Your personal access token is never populated to the client!* |
| `kirby-reporter.disabled` | Setting this option to `true` disables the plugin completely. |
| `kirby-reporter.disabled` | Setting this option to `true` disables the plugin completely. This option *must* be present. |

### Example
```php
// site/config/config.php
return [
'kirby-reporter.disabled' => false, // set true to disable the plugin
'kirby-reporter.repository' => 'https://github.com/gearsdigital/kirby-reporter',
'kirby-reporter.token' => 'c56658e7c03a5995e2e1491e6a3b93fcde6225c9'
];
```

## Configuration

Expand Down

0 comments on commit a6e92cf

Please sign in to comment.