Skip to content

Commit 2016857

Browse files
committed
Add hero image and updates to README.
1 parent f5cc620 commit 2016857

File tree

2 files changed

+27
-12
lines changed

2 files changed

+27
-12
lines changed

README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Japanese Micro Seasons Plugin for Kirby
22

3+
![Plugin Preview](src/assets/microseasons-plugin.jpg)
4+
35
Output information for one of the [72 Japanese micro season](https://www.nippon.com/en/features/h00124/) based on the current date directly into your Kirby templates and customize using the provided options in your Kirby `config.php` file.
46

57
## Requirements
@@ -10,11 +12,15 @@ Output information for one of the [72 Japanese micro season](https://www.nippon.
1012

1113
### [Kirby CLI](https://github.com/getkirby/cli)
1214

13-
kirby plugin:install scottboms/kirby-microseasons
15+
```
16+
kirby plugin:install scottboms/kirby-microseasons
17+
```
1418

1519
### Git Submodule
1620

17-
$ git submodule add https://github.com/scottboms/kirby-microseasons.git site/plugins/kirby-microseasons
21+
```
22+
$ git submodule add https://github.com/scottboms/kirby-microseasons.git site/plugins/kirby-microseasons
23+
```
1824

1925
### Copy and Paste
2026

@@ -25,26 +31,35 @@ Output information for one of the [72 Japanese micro season](https://www.nippon.
2531

2632
In any template, drop in the following line to include the output from this plugin in your site.
2733

28-
<?= snippet('microseasons') ?>
34+
```
35+
<?= snippet('microseasons') ?>
36+
```
2937

3038
## Configuration Options
3139

3240
If you want to modify the wrapper HTML element, change the wrapper class, or output the date information in a custom format, you can configure this using the included plugin options. Date formatting follows the [available format options from PHP](https://www.php.net/manual/en/function.date.php).
3341

34-
'scottboms.microseasons' => [
35-
'wrapper' => 'div', // e.g. div, article, section, span, etc.
36-
'class' => 'microseasons',
37-
'includedates' => True, // True | False
38-
'dateformat' => 'M d, Y' // e.g. 'M d', 'Y-m-d', etc.
39-
],
42+
```php
43+
<?php
44+
return [
45+
'scottboms.microseasons' => [
46+
'wrapper' => 'div', // e.g. div, article, section, span, etc.
47+
'class' => 'microseasons',
48+
'includedates' => True, // True | False
49+
'dateformat' => 'M d, Y' // e.g. 'M d', 'Y-m-d', etc.
50+
],
51+
]
52+
```
4053

4154
## Section
4255

4356
The plugin also includes a custom `section` type called `microseasons` that you can use to display information within the panel. This can be added to a blueprint and also adopts any defined configuration options.
4457

45-
sections:
46-
microseasons:
47-
type: microseasons
58+
```yml
59+
sections:
60+
microseasons:
61+
type: microseasons
62+
```
4863
4964
## Disclaimer
5065

src/assets/microseasons-plugin.jpg

302 KB
Loading

0 commit comments

Comments
 (0)