diff --git a/.babelrc b/.babelrc
deleted file mode 100644
index ce18f77..0000000
--- a/.babelrc
+++ /dev/null
@@ -1,19 +0,0 @@
-{
- "presets": [["@babel/preset-env"]],
- "ignore": ["node_modules/", "public/"],
- "plugins": [
- "@babel/plugin-proposal-object-rest-spread",
- "@babel/plugin-proposal-optional-chaining",
- [
- "module-resolver",
- {
- "root": ["./"],
- "alias": {
- "@assets": "./src/assets",
- "@components": "./src/components",
- "@plugins": "./src/plugins"
- }
- }
- ]
- ]
-}
diff --git a/.browserslistrc b/.browserslistrc
deleted file mode 100644
index ba9b28f..0000000
--- a/.browserslistrc
+++ /dev/null
@@ -1,5 +0,0 @@
-# Browsers that we support
-
-> 1%
-last 2 versions
-not dead
diff --git a/.editorconfig b/.editorconfig
index 808f9e5..ec90d88 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -3,20 +3,18 @@ root = true
[*]
charset = utf-8
end_of_line = lf
-insert_final_newline = true
-indent_style = tab
indent_size = 4
+indent_style = tab
+insert_final_newline = true
trim_trailing_whitespace = true
[*.md]
trim_trailing_whitespace = false
-indent_size = 2
-indent_style = space
[*.{yml,yaml}]
indent_size = 2
-[*.{js,vue}]
+[*.{js,ts,mts,vue}]
indent_size = 2
indent_style = tab
diff --git a/.eslintignore b/.eslintignore
index 9b1c8b1..0051b4b 100644
--- a/.eslintignore
+++ b/.eslintignore
@@ -1 +1,4 @@
-/dist
+# don't ever lint node_modules
+node_modules
+# don't lint build output (make sure it's set to your correct build folder name)
+dist
diff --git a/.eslintrc-auto-import.json b/.eslintrc-auto-import.json
new file mode 100644
index 0000000..95f0727
--- /dev/null
+++ b/.eslintrc-auto-import.json
@@ -0,0 +1,64 @@
+{
+ "globals": {
+ "CSSProperties": true,
+ "Component": true,
+ "ComponentPublicInstance": true,
+ "ComputedRef": true,
+ "EffectScope": true,
+ "InjectionKey": true,
+ "PropType": true,
+ "Ref": true,
+ "VNode": true,
+ "computed": true,
+ "createApp": true,
+ "customRef": true,
+ "defineAsyncComponent": true,
+ "defineComponent": true,
+ "effectScope": true,
+ "getCurrentInstance": true,
+ "getCurrentScope": true,
+ "h": true,
+ "inject": true,
+ "isProxy": true,
+ "isReactive": true,
+ "isReadonly": true,
+ "isRef": true,
+ "markRaw": true,
+ "nextTick": true,
+ "onActivated": true,
+ "onBeforeMount": true,
+ "onBeforeUnmount": true,
+ "onBeforeUpdate": true,
+ "onDeactivated": true,
+ "onErrorCaptured": true,
+ "onMounted": true,
+ "onRenderTracked": true,
+ "onRenderTriggered": true,
+ "onScopeDispose": true,
+ "onServerPrefetch": true,
+ "onUnmounted": true,
+ "onUpdated": true,
+ "provide": true,
+ "reactive": true,
+ "readonly": true,
+ "ref": true,
+ "resolveComponent": true,
+ "shallowReactive": true,
+ "shallowReadonly": true,
+ "shallowRef": true,
+ "toRaw": true,
+ "toRef": true,
+ "toRefs": true,
+ "triggerRef": true,
+ "unref": true,
+ "useAttrs": true,
+ "useCssModule": true,
+ "useCssVars": true,
+ "useSlots": true,
+ "useTheme": true,
+ "watch": true,
+ "watchEffect": true,
+ "watchPostEffect": true,
+ "watchSyncEffect": true
+ }
+}
\ No newline at end of file
diff --git a/.eslintrc.js b/.eslintrc.js
index 2ac168a..49c93cc 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -4,14 +4,21 @@ module.exports = {
node: true,
},
extends: [
- 'airbnb-base',
'eslint:recommended',
'plugin:vue/essential',
+ 'plugin:@typescript-eslint/recommended',
+ '@vue/typescript/recommended',
+ 'prettier',
+ './.eslintrc-auto-import.json',
+ ],
+ ignorePatterns: [
+ '.eslintrc.js',
+ 'stylelint.config.js',
+ 'vite.build.config.mts',
+ 'vite.config.mts',
+ 'vitest.config.mts',
+ '*.bk.vue',
],
- globals: {
- socket: true,
- PDFObject: true,
- },
overrides: [
{
files: [
@@ -22,23 +29,36 @@ module.exports = {
},
},
],
- parser: 'vue-eslint-parser',
+ globals: {
+ Entry: true,
+ },
parserOptions: {
- parser: '@babel/eslint-parser',
- ecmaVersion: 12,
- sourceType: 'module',
+ parser: '@typescript-eslint/parser',
},
plugins: [
+ '@typescript-eslint',
'import',
+ 'prettier',
'vue',
- '@babel',
],
+ root: true,
settings: {
'import/resolver': {
- 'babel-module': {},
},
},
rules: {
+ '@typescript-eslint/ban-ts-comment': 0,
+ '@typescript-eslint/ban-types': [
+ 'error',
+ {
+ 'extendDefaults': true,
+ 'types': {
+ '{}': false,
+ }
+ },
+ ],
+ '@typescript-eslint/no-empty-function': 0,
+ '@typescript-eslint/no-explicit-any': 0,
'brace-style': ['error', 'stroustrup'],
'default-case': [
'error', {
@@ -55,9 +75,11 @@ module.exports = {
'linebreak-style': 0,
'max-len': 0,
'no-else-return': ['error', { allowElseIf: true }],
- 'no-console': ['warn', { allow: ['warn', 'error', 'info'] }],
+ 'no-console': ['warn', { allow: ['warn', 'error', 'info', 'trace'] }],
+ 'no-const-assign': 'error',
'no-debugger': 0,
'no-new': 0,
+ 'no-undef': 0,
'no-unused-vars': 1,
'no-use-before-define': 0,
'no-useless-escape': 0,
@@ -92,14 +114,40 @@ module.exports = {
'space-before-function-paren': ['error', {
anonymous: 'never',
named: 'never',
- asyncArrow: 'never',
+ asyncArrow: 'always',
+ }],
+ 'vue/attributes-order': ['error', {
+ 'alphabetical': true,
+ 'order': [
+ 'DEFINITION',
+ 'LIST_RENDERING',
+ 'CONDITIONALS',
+ 'RENDER_MODIFIERS',
+ 'GLOBAL',
+ ['UNIQUE', 'SLOT'],
+ 'TWO_WAY_BINDING',
+ 'OTHER_DIRECTIVES',
+ 'OTHER_ATTR',
+ 'EVENTS',
+ 'CONTENT',
+ ],
}],
'vue/html-closing-bracket-newline': 0,
'vue/html-indent': 0,
'vue/html-self-closing': 0,
'vue/max-attributes-per-line': 0,
+ 'vue/no-multiple-template-root': 0,
'vue/no-template-shadow': 0,
+ 'vue/no-v-for-template-key': 0,
'vue/no-v-html': 0,
'vue/singleline-html-element-content-newline': 0,
+ 'vue/sort-keys': ['error', 'asc', {
+ caseSensitive: true,
+ ignoreChildrenOf: ['model', 'defineProps'],
+ ignoreGrandchildrenOf: ['computed', 'directives', 'inject', 'props', 'watch', 'defineProps'],
+ minKeys: 2,
+ natural: true,
+ }],
+ 'vue/valid-template-root': 0,
},
};
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..150568d
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,99 @@
+# Contributing to this repository
+
+## Getting started
+
+Before you begin:
+- Have you read the [code of conduct](CODE_OF_CONDUCT.md)?
+- Check out the [existing issues](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/issues).
+
+### Don't see your issue? Open one
+
+If you spot something new, open an issue using a [template](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix.
+
+### Ready to make a change? Fork the repo
+
+Fork using the command line:
+
+- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
+
+### Make your update:
+
+Make your changes to the file(s) you'd like to update.
+Update the CHANGELOG.md with the updates you made, please include the date and Github username.
+
+### Open a pull request
+When you're done making changes and you'd like to propose them for review, open your PR (pull request).
+
+### Submit your PR & get it reviewed
+- Once you submit your PR, others from the Vue Easter Egg Trigger community will review it with you.
+- After that, we may have questions, check back on your PR to keep up with the conversation.
+
+### Your PR is merged!
+Congratulations! The whole GitHub community thanks you. :sparkles:
+
+Once your PR is merged, you will be proudly listed as a contributor in the [contributor chart](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/graphs/contributors).
+
+### Keep contributing as you use Vue Easter Egg Trigger
+
+Now that you're a part of the Vue Easter Egg Trigger community, you can keep participating in many ways.
+
+## Types of contributions
+You can contribute to the Vue Easter Egg Trigger content and site in several ways. This repo is a place to discuss and collaborate on Vue Easter Egg Trigger! Our small, but mighty team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed.
+
+### :mega: Discussions
+Discussions are where we have conversations.
+
+If you'd like help troubleshooting a Vue Easter Egg Trigger PR you're working on, have a great new idea, or want to share something amazing you've learned, join us in [discussions](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/discussions).
+
+### :beetle: Issues
+[Issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues) are used to track tasks that contributors can help with.
+
+If you've found something in the content or the website that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue using a [template](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix.
+
+### :hammer_and_wrench: Pull requests
+A [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) is a way to suggest changes in our repository.
+
+To learn more about opening a pull request in this repo, see [Opening a pull request](#opening-a-pull-request) below.
+
+### :question: Support
+We are a small team working hard to keep up with the documentation demands of a continuously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with GitHub, unrelated to our documentation, please [contact GitHub Support directly](https://support.github.com/contact). Any issues, discussions, or pull requests opened here requesting support will be given information about how to contact GitHub Support, then closed and locked.
+
+If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact).
+
+## Starting with an issue
+You can browse existing issues to find something that needs help!
+
+### Labels
+Labels can help you find an issue you'd like to help with.
+
+- The [`help wanted` label](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for problems or updates that anyone in the community can start working on.
+- The [`documentation` label](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation) is for problems or updates relating to the README.MD documentation.
+- The [`bug` label](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/issues?q=is%3Aopen+is%3Aissue+label%3Abug) is for problems with the code and bugs.
+- The [`enhancement` label](https://github.com/webdevnerdstuff/vue-easter-egg-trigger/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for
+suggestions to improve the code or adding of additional features.
+
+## Opening a pull request
+You can use the GitHub user interface for some small changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally, to view changes and run your tests on your machine.
+
+## Working in the Vue Easter Egg Trigger repository
+Here's some information that might be helpful while working on a Vue Easter Egg Trigger PR:
+
+
+
+## Reviewing
+We (usually the Vue Easter Egg Trigger team) review every single PR. The purpose of reviews is to create the best content we can for people who use GitHub.
+
+- Reviews are always respectful, acknowledging that everyone did the best possible job with the knowledge they had at the time.
+- Reviews discuss content, not the person who created it.
+- Reviews are constructive and start conversation around feedback.
+
+### Self review
+You should always review your own PR first.
+
+
+
+### Suggested changes
+We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
+
+As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
index 2400b0d..0f7a7df 100644
--- a/.github/FUNDING.yml
+++ b/.github/FUNDING.yml
@@ -1,2 +1,3 @@
-custom: ["https://bit.ly/wdns-paypal-veet-plugin"]
+buy_me_a_coffee: webdevnerdstuff
+custom: ["paypal.me/webdevnerdstuff"]
patreon: webdevnerdstuff
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index dd84ea7..828df55 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,38 +1,45 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug", "triage"]
+assignees:
+ - webdevnerdstuff
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this bug report!
+ - type: textarea
+ id: bug-description
+ attributes:
+ label: Bug description
+ description: What happened?
+ validations:
+ required: true
+ - type: textarea
+ id: steps
+ attributes:
+ label: Steps to reproduce
+ description: Which steps do we need to take to reproduce this error?
+ placeholder: "Steps to reproduce the behavior:\n1. Go to '...'\n2. Click on '....'\n3. Scroll down to '....'"
+ validations:
+ required: true
+ - type: textarea
+ id: logs
+ attributes:
+ label: Relevant log output
+ description: If applicable, please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+ render: shell
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Additional context
+ description: Add any other context about the problem here.
+ - type: checkboxes
+ id: terms
+ attributes:
+ label: Code of Conduct
+ description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/webdevnerdstuff/vue3-easter-egg-trigger/blob/main/CODE_OF_CONDUCT.md)
+ options:
+ - label: I agree to follow this project's Code of Conduct
+ required: true
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
new file mode 100644
index 0000000..2d2fc19
--- /dev/null
+++ b/.github/workflows/main.yml
@@ -0,0 +1,42 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy to GitHub Pages
+
+on:
+ push:
+ branches: [ main ]
+
+permissions:
+ contents: write
+ pages: write
+ id-token: write
+ pull-requests: write
+ repository-projects: write
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ strategy:
+ matrix:
+ node-version: [20]
+
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Use Node.js ${{ matrix.node-version }}
+ uses: actions/setup-node@v3
+ with:
+ node-version: ${{ matrix.node-version }}
+
+ - name: Build
+ run: |
+ git config --global user.email "webdevnerdstuff@gmail.com"
+ git config --global user.name "WebDevNerdStuff"
+ mkdir docs
+ npm install --g gh-pages
+ npm i
+ npm run build:docs
+ git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+ npm run deploy -u "github-actions-bot "
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
index 19c4c2a..8e77387 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,28 +1,27 @@
-.DS_Store
-node_modules
-.history
-.vscode
-
-# local env files
-.env.local
-.env.*.local
-
-# Log files
+# Logs
+logs
+*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist-ssr
+*.local
# Editor directories and files
+.vscode/*
+.history/*
+!.vscode/extensions.json
.idea
-.vscode
+.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
-*.map
-docs
-# docs/.vuepress/dist
-demo/dist/*
+
+src/plugin/**/*.bk.*
diff --git a/.husky/pre-commit b/.husky/pre-commit
new file mode 100755
index 0000000..a16d8b1
--- /dev/null
+++ b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged
diff --git a/.npmignore b/.npmignore
index 21d5cb8..c9a372c 100755
--- a/.npmignore
+++ b/.npmignore
@@ -1,2 +1,3 @@
-demo
-*.map
+node_modules
+.github
+.history
diff --git a/.npmrc b/.npmrc
new file mode 100644
index 0000000..1765203
--- /dev/null
+++ b/.npmrc
@@ -0,0 +1 @@
+node-version=20.9.0
diff --git a/.nvmrc b/.nvmrc
new file mode 100644
index 0000000..f3f52b4
--- /dev/null
+++ b/.nvmrc
@@ -0,0 +1 @@
+20.9.0
diff --git a/.prettierrc.js b/.prettierrc.js
index 27ee62f..8d78971 100644
--- a/.prettierrc.js
+++ b/.prettierrc.js
@@ -1,4 +1,5 @@
module.exports = {
+ semi: true,
singleQuote: true,
trailingComma: 'all',
};
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
new file mode 100644
index 0000000..c0a6e5a
--- /dev/null
+++ b/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+ "recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 19787f3..1e0f66c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,6 +1,30 @@
# Change Log
All notable changes to the "vue-easter-egg-trigger" plugin will be documented in this file.
-## v0.1.24
-April 27, 2021
-[main] Initial release (webdevnerdstuff)
+## v3.0.2
+2024-01-19
+[main] (@webdevnerdstuff)
+* Fix issue when only using single key press
+
+## v3.0.1
+2024-01-17
+[main] (@webdevnerdstuff)
+* Fix links
+
+## v3.0.0
+2024-01-17
+[main] (@webdevnerdstuff)
+* Updating typescript support
+* Refactoring
+* Updating packages
+* Moving V3 version to this repo
+
+## v1.0.2
+2023-07-20
+[main] (@webdevnerdstuff)
+* Update packages
+* Update vite config for build
+
+## v1.0.0
+2022-01-26
+[main] Initial release (@webdevnerdstuff)
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..3c673b2
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+ and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+ overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+ advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+ address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+webdevnerdstuff@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
diff --git a/LICENSE.md b/LICENSE.md
index cb72d15..8e02d4e 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -1,6 +1,6 @@
MIT License
-Copyright (c) 2020 WebDevNerdStuff
+Copyright (c) 2022 WebDevNerdStuff
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
index cc4d65f..16645e8 100644
--- a/README.md
+++ b/README.md
@@ -1,194 +1,57 @@
+
+
+
+
+ Presenting the Vue Easter Egg Trigger, a tool that discreetly injects a touch of unexpectedness into Vue.js
+ projects. This unassuming plugin, which operates on both keystrokes (with click events also available), brings
+ hidden surprises to your applications.
+
+
+
+ Picture users navigating through your Vue.js application, tapping out secret combinations akin to the infamous
+ Konami code. Suddenly, a magical farting unicorn appears. While we must issue a PSA that this majestic creature
+ isn't included, the plugin serves as an invitation for developers to infuse similar unexpected elements into their
+ projects.
+
+
+
+
+
+
diff --git a/src/documentation/sections/EventsSection.vue b/src/documentation/sections/EventsSection.vue
new file mode 100644
index 0000000..41eb69d
--- /dev/null
+++ b/src/documentation/sections/EventsSection.vue
@@ -0,0 +1,84 @@
+
+
+
+
+ Available types of Mouse Events: click, dblclick, mouseup, mousedown. When using dblclick the
+ pattern will only work with one double click. Ex. pattern: ['dblclick'].
+
+
+ Mouse events require the target property to be set.
+
+ The Easter egg image was created by CutiefulCritters and is licensed under the "My spouse allowed me to use this image" license. The unicorn
+ image was created by Christine Wulf and has been licensed under the Adobe Stock Standard
+ License.
+
+
+
+
+ First clone the repository:
+
+
+
+
+
+ Next run the following command to setup the Playground:
+
+
+
+
+
+ This will create a file for you to adjust and play with.
+
+ /src/playground/PlaygroundPage.vue
+
+
+
+
+
diff --git a/src/documentation/sections/PropsSection.vue b/src/documentation/sections/PropsSection.vue
new file mode 100644
index 0000000..dd45408
--- /dev/null
+++ b/src/documentation/sections/PropsSection.vue
@@ -0,0 +1,37 @@
+
+
+
+