Skip to content

Commit

Permalink
Add curated list of plugins to README
Browse files Browse the repository at this point in the history
  • Loading branch information
DZunke committed Apr 17, 2024
1 parent 40b3fb1 commit b833959
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,35 @@ so that every plugin can form the way a projects analyzer tools bring their numb

> :warning: Open TODO - Work in Progress Project
```
composer require --dev panaly/panaly
```

After the package was installed create a file `panaly.dist.yaml` and fill it with a configuration based on the plugins
you need. Without any plugin there will be nothing done. As an example for a working configuration have a look to
the file in this repository.

## Usage

In default the CLI Command will search for a config file `panaly.dist.yaml` which can be overwritten by giving the
config file with the CLI Command like `vendor/bin/panaly -c my-own-config.yaml`.

## Curated List of Plugins

**Metric Plugins**
* [Quality Tool Baselines](https://github.com/DZunke/panaly-baseline-plugin)
* [Filesystem](https://github.com/DZunke/panaly-files)

**Storage Plugins**
* [JSON Timeline Storage](https://github.com/DZunke/panaly-json-timeline-storage)

**Reporting Plugins**
* [Markdown Report](https://github.com/DZunke/panaly-markdown-report)
* [Symfony Dump Output](https://github.com/DZunke/panaly-symfony-dump)

**Other Plugins**
* [CODEOWNERS Paths](https://github.com/DZunke/panaly-codeowners)

## Example Configuration

<details>
Expand Down

0 comments on commit b833959

Please # to comment.