Merge pull request #3 from webdevnerdstuff/dev

Dev

Author: webdevnerdstuff

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 All notable changes to the "vue-easter-egg-trigger" plugin will be documented in this file.
 
-## v0.1.23
+## v0.1.24
 April 27, 2021
 [main] Initial release (webdevnerdstuff)

README.md

@@ -2,7 +2,7 @@
 Vue Easter Egg Trigger
 -------
 
-![GitHub package.json version](https://img.shields.io/github/package-json/v/webdevnerdstuff/vue-easter-egg-trigger) [![NPM_PACKAGE](https://img.shields.io/badge/NPM%20-Package-%23cb3837)](https://github.com/webdevnerdstuff/vue-easter-egg-trigger) [![GitHub license](https://img.shields.io/github/license/webdevnerdstuff/vue-easter-egg-trigger)](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/blob/main/LICENSE.md)
+![GitHub package.json version](https://img.shields.io/github/package-json/v/webdevnerdstuff/vue-easter-egg-trigger) [![NPM_PACKAGE](https://img.shields.io/badge/NPM%20-Package-%23cb3837)](https://www.npmjs.com/package/vue-easter-egg-trigger) [![GitHub license](https://img.shields.io/github/license/webdevnerdstuff/vue-easter-egg-trigger)](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/blob/main/LICENSE.md)
 
 This packages makes it nice and easy to add Easter Egg triggers to your Vue site.
 
@@ -26,10 +26,10 @@ Vue.use(EasterEggTrigger);
 
 Name    | Type    | Default  | Description
 :-----  | :------ | :-----   | :-----
-delay   | Integer | 500 | Determins the timeout before the event lister resets
-keys    | Array   | ['ArrowUp', 'ArrowUp', 'ArrowDown', 'ArrowDown', 'ArrowLeft', 'ArrowRight', 'ArrowLeft', 'ArrowRight', 'b', 'a'] | The keys a user needs to enter to trigger the easter egg. The default combination is the konami code.
-pattern | Array   |  [38, 38, 40, 40, 37, 39, 37, 39, 66, 65] | The keyCode a user enters to trigger the easter egg. This is a fallback for the keys option as it is depreciated.
-type    | String  | keydown | The type of action the trigger will be listening for
+delay   | Integer | 500 | Determines the timeout before the event lister resets.
+keys    | Array   | ['ArrowUp', 'ArrowUp', 'ArrowDown', 'ArrowDown', 'ArrowLeft', 'ArrowRight', 'ArrowLeft', 'ArrowRight', 'b', 'a'] | The key/click combination a user does to trigger easter egg. The default combination is the konami code.
+pattern | Array   |  [38, 38, 40, 40, 37, 39, 37, 39, 66, 65] | The key combination a user does to trigger easter egg. (fallback for keys)
+type    | String  | keydown | The type of action the trigger will be listening for.
 
 ##### Overriding the plugin default options
 
@@ -177,6 +177,10 @@ this.$easterEgg({
 
 You can find more examples in the [EasterEgg.vue](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/blob/main/src/components/EasterEgg.vue) file.
 
+## Demo
+ 
+Coming soon to a farm near you.
+ 
 ## Change Log
 
 [CHANGELOG](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/blob/main/CHANGELOG.md)

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"name": "vue-easter-egg-trigger",
-	"version": "0.1.23",
+	"version": "0.1.24",
 	"description": "This packages makes it nice and easy to add Easter Egg triggers to your Vue site.",
 	"private": false,
 	"main": "dist/vue-easter-egg-trigger.js",