Skip to content

Commit c4164c7

Browse files
committed
Updated the read me a bit more
1 parent e27c328 commit c4164c7

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Fireworks for Koken
2-
Fireworks is a simple javascript and CSS plugin for the [koken cms](https://koken.me)
2+
Fireworks is a simple javascript and CSS plugin for the [koken cms](https://koken.me) that comes with decorative Christmas and New Year's Eve typeface.
33
![Fireworks preview](Fireworks/preview.jpg)
4+
45
## Features
56
* Colorful holidays firekworks
67
* Customizable greating message
78
* Custom Xmas:ish [fontface](#christmas-fontface-character-map)
89
* Fluid and responsive font sizes
910
* Only displayed once per visit/browser session
11+
* Automaticly updates the year
1012

1113
## Installation
1214

@@ -16,11 +18,16 @@ Fireworks is a simple javascript and CSS plugin for the [koken cms](https://koke
1618
![Fireworks settings](screens/settings.png)
1719
4. And Done
1820

19-
### Christmas Fontface Character Map
21+
### Merry Christmas Fontface Character Map
22+
![Merry Christmas](screens/merry-christmas.png)
2023
![Character Map](screens/character-map-merry-christmas.png)
2124

25+
### TODO
26+
* Add check so it only will run between MMDD -> MMDD
27+
I.e it will only run between Dec 11 -> Jan 1
28+
2229
### Credits
2330

2431
* The original JS and inspiration comes from: [Fireworks - Happy 2019!](https://codepen.io/TC5550/pen/NejPqE) [by: Alfons Nilsson](https://aaserver.net) @TheCoder5550
25-
* Christmas fontface [Måns Grebäck](http://www.aringtypeface.com/)
32+
* [Merry Christmas fontface](https://www.mansgreback.com/fonts/merry-christmas/) by [Måns Grebäck](http://www.aringtypeface.com/)
2633
* preview image comes from: [Epic Fireworks](https://www.flickr.com/photos/epicfireworks/8058678846) and is used under [CC licensing](https://creativecommons.org/licenses/by/2.0/).

screens/merry-christmas.png

19.7 KB
Loading

0 commit comments

Comments
 (0)