Skip to content

Commit

Permalink
better readme
Browse files Browse the repository at this point in the history
Signed-off-by: Bruno Meilick <b@bnomei.com>
  • Loading branch information
bnomei committed Aug 25, 2019
1 parent 0c22591 commit d75711d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 23 deletions.
32 changes: 9 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,29 +151,15 @@ Since 1.3.0 you can access the Page-Object the Panel-Field was called at and the

## Settings

All settings must be prefixed with `bnomei.janitor.`.

**jobs**
- default: `[]` array of keys => callbacks:bool|array

**jobs.extends**
- default: `[]` array of names to other keys => callbacks:bool|array options
- example: `['bvdputte.kirbyqueue.queues']`

**label.cooldown**
- default: `2000`ms. the field allow you to override this as well.

**exclude**
- default: `['bnomei/autoid', 'bnomei/fingerprint']` array of foldernames to exclude.

**secret**
- default: `null`, any string

**log.enabled**
- default: `false`, if enabled it try to call [Kirby-log Plugin](https://github.com/bvdputte/kirby-log)

**simulate**
- default: `false`, will not remove any files if enabled. You could check this option in your customs jobs as well if you want to support simulating the job.
| bnomei.janitor. | Default | Description |
|---------------------------|----------------|---------------------------|
| jobs | `array of callbacks` | array of `['key' => function() { return (bool or array); } ]` |
| jobs.extends | `[]` | array of names to other job definitions. example: `['bvdputte.kirbyqueue.queues']` |
| label.cooldown | `2000` | in millisecondss. the field allow you to override this as well. |
| exclude | `['bnomei/autoid', 'bnomei/fingerprint']` | array of foldernames to exclude. |
| secret | `null` | any string |
| log.enabled | `false` | if enabled it try to call [Kirby-log Plugin](https://github.com/bvdputte/kirby-log) |
| simulate | `false` | will not remove any files if enabled. You could check this option in your customs jobs as well if you want to support simulating the job. |

## Disclaimer

Expand Down
2 changes: 2 additions & 0 deletions classes/Janitor.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
use function time;
use function trim;

// TODO: split in core logic and cache cleaning logic

class Janitor
{
public static function cacheRemoveUnusedFiles()
Expand Down

0 comments on commit d75711d

Please sign in to comment.