Skip to content

Commit 38822b7

Browse files
committed
Update README.md
1 parent 267c067 commit 38822b7

File tree

3 files changed

+12
-33
lines changed

3 files changed

+12
-33
lines changed

.github/banner.png

2.56 KB
Loading

README.md

Lines changed: 10 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,22 @@
1-
![Kirby Skeleton Plugin](/.github/banner.png)
1+
![Kirby PHP Blueprint Loader Plugin](/.github/banner.png)
22

3-
# My Kirby plugin readme
3+
# Kirby PHP Blueprint Loader Plugin
44

5-
This is our boilerplate for Kirby plugins. Put a short description of what your plugin does here.
5+
Start using PHP blueprints in your `site` folder today!
66

77
> ⚡ Ready for Kirby 4!
88
99
----
1010

11-
> [!NOTE]
12-
> Delete this section after you are done.
13-
14-
This is our boilerplate for Kirby plugins. Create a project from this repository to create a new plugin and adjust the files accordingly:
15-
16-
```bash
17-
# Adjust `my-new-kirby-plugin` to whatever you want to name the output folder
18-
composer create-project presprog/kirby-skeleton-plugin my-new-kirby-plugin
19-
```
20-
1. Update `composer.json`:
21-
* Update the package name
22-
* Update the PSR-4 namespace (or remove entirely)
23-
* Update the installer name (or remove entirely)
24-
2. Set the package name in `index.php`
25-
3. Set the package name in `panel/index.js`
26-
4. Add [badges](https://poser.pugx.org/), if you like
27-
5. Write a proper `README.md` for your plugin
28-
29-
----
30-
3111
## 🚀 How to use
3212

33-
13+
Kirby lets you use PHP-based blueprints in plugins, e.g. to use different blueprints for different user roles. This is thoroughly described [in Sonja's fantastic cook book article](https://getkirby.com/docs/cookbook/development-deployment/programmable-blueprints). Unfortunately, this does not work with the native `blueprints` folder, usually residing in `site/blueprints`.
14+
15+
After installing this plugin, you can start using PHP-based blueprints in `site/blueprints` folder, just like you would in plugins!
3416

35-
## ⚙️ Config
17+
Happy Coding!
3618

37-
19+
[//]: # (## ⚙️ Config)
3820

3921
## 💻 How to install
4022

@@ -44,15 +26,11 @@ Install this plugin via **Composer**:
4426
composer require presprog/kirby-php-blueprint-loader
4527
```
4628

47-
Or **download the ZIP file** from GitHub and unpack it to `site/plugins/kirby-php-blueprint-loader`
48-
49-
## ✅ To do
50-
51-
29+
Or **download the ZIP file** from GitHub and unpack it to `site/plugins/php-blueprint-loader`
5230

5331
## 📄 License
5432

55-
MIT License Copyright © 2024 Present Progressive
33+
MIT License Copyright © 2025 Present Progressive
5634

5735
----
5836

composer.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "presprog/kirby-php-blueprint-loader",
3-
"description": "Describe your plugin here",
3+
"description": "Load PHP blueprints not only from plugins, but your `site` folder, too!",
4+
"keywords": ["Kirby", "Blueprint Loader"],
45
"license": "MIT",
56
"type": "kirby-plugin",
67
"authors": [

0 commit comments

Comments
 (0)