Skip to content
Permalink
Browse files

Update README.md

  • Loading branch information
georgemandis committed Jun 13, 2019
1 parent 087be6f commit dc03ee58b498ee8fc41ec3ce2bcdf5bbbd745bf4
Showing with 9 additions and 11 deletions.
  1. +9 −11 README.md
@@ -1,22 +1,22 @@
# Konami-JS

Add the [Konami Code](https://en.wikipedia.org/wiki/Konami_Code) as an easter egg to your web project. Compatible with keyboards and touch events.
Add the [Konami Code](https://en.wikipedia.org/wiki/Konami_Code) as an easter egg to your web project. Compatible with keyboard and touch events.

For example and additional information please visit: https://snaptortoise.github.io/konami-js/
For examples and additional information please visit: https://snaptortoise.github.io/konami-js/

## Install

- [Download the latest source](https://github.com/snaptortoise/konami-js/archive/master.zip) and include konami.js in your project
- [Download the latest source](https://github.com/snaptortoise/konami-js/archive/master.zip) and include `konami.js` in your project
- Install with [npm](https://www.npmjs.com): `npm install konami`
- Install with [bower](https://bower.io): `bower install konami-js`

## Future Improvements

Konami-JS is an ancient project by JavaScript standards, having started in 2009! I would love for 2018 to be the year it gets rewritten in a more modern, ES6-friendly way while incorporating something like [Babel](https://babeljs.io) to ensure backwards compatibility in older browsers.
Konami-JS is an ancient project by JavaScript standards, having started in 2009! I would love for 2019 to be the year it gets rewritten in a more modern way. Please checkout the issues and discussions surrounding the `2.0` branch.

I would love the community's help in any of this 😃
I welcome the community's help in any of this 😃

You can watch [me](https://george.mand.is) talk about the history of Konami-JS and the value of maintaining "frivolous" open-source projects at OdessaJS 2017 here: [https://www.youtube.com/embed/F3xI3ps7syI](https://www.youtube.com/embed/F3xI3ps7syI)</p>
You can watch [me](https://george.mand.is) talk about the history of Konami-JS and the joy & value of maintaining "frivolous" open-source projects at OdessaJS here: [https://www.youtube.com/embed/F3xI3ps7syI](https://www.youtube.com/embed/F3xI3ps7syI)</p>


Notable instances of Konami-JS in the wild include:
@@ -31,14 +31,12 @@ Notable instances of Konami-JS in the wild include:
* ...and MANY more!

## Forks
If you'd prefer to use a coffeescript version you can find one here:

If you'd prefer to use a coffeescript version you can find one here:
[https://github.com/camray/konami-coffee](https://github.com/camray/konami-coffee)

If you are looking for GamePad support check out this fork:

If you are looking for GamePad support check out this fork:
[https://github.com/TomBebbington/konami-js](https://github.com/TomBebbington/konami-js)

## Contributions

Your pull requests are welcome! Emphasis on small footprints, speed and broad device/browser compatability. Less interested in package manager and toolchain integrations.
Your pull requests are welcome! Emphasis on small footprints, speed and broad device/browser compatability. Less interested in package manager and toolchain integrations—though that may change with the `2.0` branch.

0 comments on commit dc03ee5

Please sign in to comment.
You can’t perform that action at this time.