README.md
# Reporter for Kirby
[![Maintainability](https://img.shields.io/codeclimate/maintainability/gearsdigital/reporter-for-kirby.svg)](https://codeclimate.com/github/gearsdigital/reporter-for-kirby)
[![Codefactor](https://img.shields.io/codefactor/grade/github/gearsdigital/reporter-for-kirby.svg)](https://www.codefactor.io/repository/github/gearsdigital/reporter-for-kirby)
[![Kirby](https://img.shields.io/badge/kirby-3.6-brightgreen.svg)](https://getkirby.com/)
## Gather feedback directly out of the Panel!
Enable your editors or clients to submit tasks, bugs and ideas either straight to your issue tracker or by E-Mail.
### Documentation
You can find a detailed documentation here: [https://gearsdigital.github.io/reporter-for-kirby-docs](https://gearsdigital.github.io/reporter-for-kirby-docs)
### Installation
You can install **Reporter _for Kirby_** using one of the following methods. The preferred one is Composer.
#### Composer
```shell
composer require gearsdigital/reporter-for-kirby
```
> If you aren't familiar with Composer, I recommend reading the cookbook article [»Kirby meets Composer«](https://getkirby.com/docs/cookbook/setup/composer)
by [Lukas Bestle](https://lukasbestle.com/)
#### Submodule
```shell
git submodule add https://github.com/gearsdigital/reporter-for-kirby.git site/plugins/reporter-for-kirby
```
> You need to perform this command in your Kirby root directory!
#### Manual
1. Download the [latest version](https://github.com/gearsdigital/kirby-reporter/releases)
2. Extract the archive and rename the folder to `reporter-for-kirby`
3. Move the directory to `/site/plugins`