Skip to content

Commit a4f8376

Browse files
authored
Update README.md
1 parent a98c566 commit a4f8376

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
# Autoloader for Kirby
22

3-
![Release](https://flat.badgen.net/packagist/v/bnomei/autoloader-for-kirby?color=ae81ff)
4-
![Downloads](https://flat.badgen.net/packagist/dt/bnomei/autoloader-for-kirby?color=272822)
5-
[![Coverage](https://flat.badgen.net/codeclimate/coverage/bnomei/autoloader-for-kirby)](https://codeclimate.com/github/bnomei/autoloader-for-kirby)
6-
[![Maintainability](https://flat.badgen.net/codeclimate/maintainability/bnomei/autoloader-for-kirby)](https://codeclimate.com/github/bnomei/autoloader-for-kirby)
7-
[![Discord](https://flat.badgen.net/badge/discord/bnomei?color=7289da)](https://discordapp.com/users/bnomei)
3+
[![Kirby 5](https://flat.badgen.net/badge/Kirby/5?color=ECC748)](https://getkirby.com)
4+
![PHP 8.2](https://flat.badgen.net/badge/PHP/8.2?color=4E5B93&icon=php&label)
5+
![Release](https://flat.badgen.net/packagist/v/bnomei/autoloader-for-kirby?color=ae81ff&icon=github&label)
6+
![Downloads](https://flat.badgen.net/packagist/dt/bnomei/autoloader-for-kirby?color=272822&icon=github&label)
7+
[![Coverage](https://flat.badgen.net/codeclimate/coverage/bnomei/autoloader-for-kirby?icon=codeclimate&label)](https://codeclimate.com/github/bnomei/autoloader-for-kirby)
8+
[![Maintainability](https://flat.badgen.net/codeclimate/maintainability/bnomei/autoloader-for-kirby?icon=codeclimate&label)](https://codeclimate.com/github/bnomei/autoloader-for-kirby/issues)
9+
[![Discord](https://flat.badgen.net/badge/discord/bnomei?color=7289da&icon=discord&label)](https://discordapp.com/users/bnomei)
10+
[![Buymecoffee](https://flat.badgen.net/badge/icon/donate?icon=buymeacoffee&color=FF813F&label)](https://www.buymeacoffee.com/bnomei)
811

912
Helper to automatically load various Kirby extensions in a plugin
1013

@@ -14,14 +17,14 @@ Helper to automatically load various Kirby extensions in a plugin
1417
composer require bnomei/autoloader-for-kirby
1518
```
1619

17-
## This package is NOT a kirby plugin
20+
## This package is NOT a Kirby plugin
1821

19-
- This is a composer package because that actually makes it easier to setup and does not mess with the loading order of extensions.
20-
- Being a package it also can be used not only for local plugins but also as a composer dependency within plugins published online.
22+
This is a composer package because it is easier to set up and does not mess with the loading order of extensions.
23+
- Being a package, it can also be used not only for local plugins but also as a composer dependency within plugins published online.
2124

2225
### Autoloading of extensions
2326

24-
Add the autoloader for each extension type you want once and it will register all files in subfolders correctly.
27+
Add the autoloader for each extension type you want once, and it will correctly register all files in subfolders.
2528

2629
#### Supported Extensions
2730

@@ -43,8 +46,8 @@ The following extensions can be autoloaded:
4346

4447
#### Notes
4548

46-
- Loading translations from yaml or json files is added by this package and not originally part of kirby core.
47-
- The `classes` autoloader is very basic. Using a custom array with kirby's `load()`-helper or composers psr-4 autoloading is recommended.
49+
- Loading translations from YAML or JSON files are added by this package and is not originally part of Kirby core.
50+
- The `classes` autoloader is very basic. It is recommended that you use a custom array with Kirby's `load()` helper or composers psr-4 autoloading.
4851
- The `routes` and `apiRoutes` autoloader is based on code from @tobimori and needs a file structure similar to Next.js [see examples](https://github.com/bnomei/autoloader-for-kirby/blob/main/tests/site/plugins/routastic).
4952
- Blueprints loaded from classes need the [kirby-blueprints](https://github.com/bnomei/kirby-blueprints) plugin
5053

@@ -126,10 +129,6 @@ Kirby::plugin('bnomei/example', autoloader(__DIR__, [
126129
);
127130
```
128131

129-
## Suggestion
130-
131-
This plugin works great in combination with my [Kirby CLI Tool](https://github.com/bnomei/kirby3-plopfile) which helps you to create extension files faster.
132-
133132
## Disclaimer
134133

135134
This package is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please [create a new issue](https://github.com/bnomei/autoloader-for-kirby/issues/new).

0 commit comments

Comments
 (0)