Skip to content

Commit c4e63cd

Browse files
committed
📝 added usecase description
1 parent ab9c89d commit c4e63cd

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

+17
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,23 @@ of your request to maintain data consistency. This will make it behave like a da
5252
> No matter how many php-fpm workers you have, only one will be running at a time when Nitro is in atomic mode! You have
5353
> been warned! But this is the only way to guarantee data consistency, and it will still be wicked fast.
5454
55+
## Usecase
56+
57+
The plugin will speed up Kirby setups, loading 100-2000 page models in a single request by providing a special
58+
cache. It solves the three major performance bottlenecks in Kirby that I know of and links the cache between CLI and
59+
HTTP requests.
60+
61+
It does this by:
62+
63+
- Providing a regular file cache you can use yourself. But the cache is always fully loaded in every request and only
64+
uses a single file, which makes it wicked fast.
65+
- Optionally you can use that cache for storing the UUID to page ID relations. So instead of loading a single file for
66+
every page model UUID resolution, the cache will have them ready instantly.
67+
- It allows you to store the TXT content of selected page/file/user models in the cache to speed up the loading time of
68+
content.
69+
- I uses a second cache, which will cache `Dir::index` results. This will skip crawling the file structure step in
70+
populating the full index from the cache until you update any page/file.
71+
5572
## Setup
5673

5774
For each template you want to be cached you need to use a model to add the content cache logic using a trait.

0 commit comments

Comments
 (0)