Skip to content

Commit

Permalink
Updated the read me a bit more
Browse files Browse the repository at this point in the history
  • Loading branch information
BlackSkorpio committed Jan 7, 2019
1 parent e27c328 commit c4164c7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Fireworks for Koken
Fireworks is a simple javascript and CSS plugin for the [koken cms](https://koken.me)
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.
![Fireworks preview](Fireworks/preview.jpg)

## Features
* Colorful holidays firekworks
* Customizable greating message
* Custom Xmas:ish [fontface](#christmas-fontface-character-map)
* Fluid and responsive font sizes
* Only displayed once per visit/browser session
* Automaticly updates the year

## Installation

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

### Christmas Fontface Character Map
### Merry Christmas Fontface Character Map
![Merry Christmas](screens/merry-christmas.png)
![Character Map](screens/character-map-merry-christmas.png)

### TODO
* Add check so it only will run between MMDD -> MMDD
I.e it will only run between Dec 11 -> Jan 1

### Credits

* The original JS and inspiration comes from: [Fireworks - Happy 2019!](https://codepen.io/TC5550/pen/NejPqE) [by: Alfons Nilsson](https://aaserver.net) @TheCoder5550
* Christmas fontface [Måns Grebäck](http://www.aringtypeface.com/)
* [Merry Christmas fontface](https://www.mansgreback.com/fonts/merry-christmas/) by [Måns Grebäck](http://www.aringtypeface.com/)
* 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/).
Binary file added screens/merry-christmas.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c4164c7

Please sign in to comment.