Example readme for Kirby plugins - MOVED TO KIRBY SECRETS

Kirby 2 Solved ✅
1

For me and other plugin developers, I just released Kirby Boiler Readme. It’s a Github readme.md boilerplate file expecially for Kirby plugins.

https://github.com/jenstornell/kirby-boiler-readme

Update

I removed it in the forum because it was not up to date. To always have the latest version, visit Github. :slight_smile:

4 Likes
2

At first, I thought that it was a readme for the ‘boiler’. Turns out, it’s a Plugin Readme Boilerplate. Confusing :smiley:

3

Ahh, yes I can see the confusion. Why I named it that way was to make it consistent.

My repo names:

kirby-boiler-field
kirby-boiler-readme

But maybe it does more harm than good to name the readme repo like that as well?

4

I made a big update today:

https://github.com/jenstornell/kirby-boiler-readme

Big thanks to @Thiousi and @flokosiol for all your help. :slight_smile:

2 Likes
5

Great result.
Thanks @jenstornell for putting all pieces together. I think I will update my readme files soon :wink:

1 Like
6

Moving this repo to Kirby Secrets

I’m moving this repo to Kirby Secrets to have all unofficial docs in a single place.

kirby-secrets
kirby-secrets/wiki/Boiler-readme

2 Likes
7

This repo has been removed but you can still find it here: https://github.com/jenstornell/kirby-secrets/blob/master/docs/plugin/readme.md