Skip to content

Commit 35a24cf

Browse files
committed
Add documentation on additional config option needed for caching.
1 parent 0c0aad0 commit 35a24cf

File tree

3 files changed

+21
-13
lines changed

3 files changed

+21
-13
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,19 @@ If you want to explore the data returned via the plugin to the snippet or that y
4646

4747
## Configuration Options
4848

49-
| Property | Default | Required? | Description |
50-
|-----------------|-----------------|-----------|------------------------------------------------|
51-
| username | `null` | Yes | Your Mastodon username |
52-
| instance | `null` | Yes | Your Mastodon instance (e.g. mastodon.social) |
53-
| cache | `true` | No | Caches data returned from Mastodon API. |
54-
| cachettl | `900` | No | Cache timeout - 15 minutes default (900s) |
55-
| limit | `20` | No | Number of results to return/display |
56-
| dateformat | `M d, Y` | No | Adjust date format per PHP datetime formats |
57-
| excludereplies | `true` | No | Exclude replies from results? |
58-
| onlymedia | `false` | No | Only show posts with media attachments? |
59-
| panel.limit | `12` | No | Number of results to display in the Panel Area |
49+
| Property | Default | Req? | Description |
50+
|-------------------------------|----------|------|------------------------------------------------|
51+
| cache.scottboms.mastodon.type | `file` | Yes | Required to enable cache type for the plugin |
52+
| username | `null` | Yes | Your Mastodon username |
53+
| server | `null` | Yes | Your Mastodon server (e.g. mastodon.social) |
54+
| cache | `true` | No | Caches data returned from Mastodon API. |
55+
| cachettl | `900` | No | Cache timeout - 15 minutes default (900s) |
56+
| limit | `20` | No | Number of results to return/display (max 40) |
57+
| dateformat | `M d, Y` | No | Adjust date format per PHP datetime formats |
58+
| excludereplies | `true` | No | Exclude replies from results? |
59+
| onlymedia | `false` | No | Only show posts with media attachments? |
60+
| panel.limit | `12` | No | Number of results to display in the Panel Area |
61+
6062

6163
Date formatting follows the [available format options from PHP](https://php.net/manual/en/function.date.php).
6264

@@ -65,6 +67,12 @@ Example Config:
6567
```php
6668
<?php
6769
return [
70+
'cache' => [
71+
'scottboms.mastodon' => [
72+
'type' => 'file',
73+
]
74+
],
75+
6876
'scottboms.mastodon' => [
6977
'username' => 'scottboms',
7078
'instance' => 'mastodon.social',

index.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
'homepage' => 'https://github.com/scottboms/kirby-mastodon-feed',
3434
'license' => 'MIT'
3535
],
36-
version: '1.1.0',
36+
version: '1.1.1',
3737
extends: [
3838
'options' => [
3939
'username' => null,

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "mastodon-feed",
33
"description": "Mastodon Feed plugin for Kirby",
44
"author": "Scott Boms <[email protected]>",
5-
"version": "1.1.0",
5+
"version": "1.1.1",
66
"type": "kirby-plugin",
77
"license": "MIT",
88
"scripts": {

0 commit comments

Comments
 (0)