repo cosmetics

Author: SimulatedGREG

LICENSE.md

@@ -0,0 +1,5 @@
+Copyright (c) 2016, SimulatedGREG <[email protected]>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

LINCENSE.md

@@ -1,10 +1,10 @@
 [Kappa]: http://static-cdn.jtvnw.net/emoticons/v1/25/1.0
 
-# ![Kappa Emote][Kappa] Kappa.js v1.0.8
+# ![Kappa Emote][Kappa] Kappa.js v2.0.0
 Kappa.js is a simple jQuery Plugin that can easily find text Twitch emotes and replace them with their respective emoticons.  
 
 ## How does this work?
-Kappa.js is made possible with the use of [Twitch Emotes API v2](http://twitchemotes.com/apidocs). Kappa.js will pull a fresh list of **global emotes** on each browser session. Please note this API is currently in *development*, so features and structure may change without warning.
+Kappa.js is made possible with the use of [Twitch Emotes API v2](http://twitchemotes.com/apidocs). Kappa.js will pull a fresh list of **global emotes** and save in localStorage. Please note this API is currently in *development*, so features and structure may  change without warning.
 
 ## How do I get this?
 Kappa.js can be quickly installed from the public bower registry. Just run...
@@ -28,12 +28,12 @@ To get started include the `kappa.js` file just before the end of your closing `
 ```
 Once included use jQuery to select which elements your want `kappa.js` to apply in this manner... `$([selector]).kappa([options]);`
 
-In this example `kappa.js` will apply to all elements in the DOM once the page is loaded.
+In this example `kappa.js` will apply to elements with `class="kappa"` in the DOM once the page is loaded.
 ```html
         ...
         <script>
-            $(function () {
-                $('*').kappa();
+            $(document).ready(function() {
+              $('.kappa').kappa();
             });
         </script>
     </body>
@@ -42,16 +42,12 @@ In this example `kappa.js` will apply to all elements in the DOM once the page i
 And that's it! There's nothing else to do. All text emotes will be replaced with their respective Twitch emoticons. But wait, there's more!
 
 ### Options
-As of now, options are limited to only emoticon size. More to come!
 
 | option    | type   | default | description                                                                  |
 |:-----------|:--------|:-------|:------------------------------------------------------------------------------|
 | emoteSize | string | `'small'` | Sets emoticon image size. Can be `'small'`, `'medium'`, or `'large'`. |
 | customClass | string | `null` | Adds a custom class to each injected `<img>` emoticon. |
 
-## What's next?
-In the near future I plan to add support for subscriber emotes.
-
 #### Credits
 [Twitch Emotes API v2](http://twitchemotes.com/apidocs)  
 *Emote and badge images are property of [Twitch Interactive](http://www.twitch.tv/) and their respective owners.*

README.md

@@ -1,12 +1,12 @@
 {
   "name": "Kappa.js",
-  "version": "1.0.8",
+  "version": "2.0.0",
   "homepage": "http://simulatedgreg.github.io/kappa.js/",
   "authors": [
     "Greg Holguin <[email protected]>"
   ],
   "description": "A simple jQuery plugin that can easily find text Twitch emotes and replace them with their respective emoticons.",
-  "main": "dist/kappa.js",
+  "main": "dist/kappa.min.js",
   "keywords": [
     "kappa",
     "twitch",

bower.json

@@ -5,7 +5,7 @@
   /**
    * Check for previous data in localStorage
    */
-  var previousStorage = window.localStorage.getItem('kappa-js');
+  var previousStorage = localStorage.getItem('kappa-js');
 
   /**
    * Initialize KappaJS
@@ -26,7 +26,7 @@
    */
   function getTwitchEmotesPromise(res, rej) {
     $.get('https://twitchemotes.com/api_cache/v2/global.json', function (data) {
-      if (typeof Storage !== 'undefined') window.localStorage.setItem('kappa-js', JSON.stringify(data));
+      if (typeof Storage !== 'undefined') localStorage.setItem('kappa-js', JSON.stringify(data));
 
       res(data);
     });
@@ -40,7 +40,7 @@
     init().then(function (data) {
       window.KappaJS = data;
     });
-  } else window.KappaJS = JSON.parse(window.localStorage.getItem('kappa-js'));
+  } else window.KappaJS = JSON.parse(localStorage.getItem('kappa-js'));
 
   /**
    * Initialize jQuery Plugin

dist/kappa.js

@@ -5,8 +5,7 @@
     <title>Kappa.js</title>
   </head>
   <body>
-    <div class="kappa">Kappa Kappa Kappa</div>
-
+    <div class="kappa">Kappa FailFish WutFace</div>
 
     <script src="https://code.jquery.com/jquery-2.2.0.min.js"></script>
     <script src="dist/kappa.js"></script>

dist/kappa.min.js

@@ -1,8 +1,8 @@
 {
   "name": "kappa.js",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Kappa.js is a simple jQuery Plugin that can easily find text Twitch emotes and replace them with their respective emoticons.  ",
-  "main": "kappa.js",
+  "main": "dist/kappa.min.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -33,5 +33,6 @@
     "gulp-babel": "^6.1.2",
     "gulp-rename": "^1.2.2",
     "gulp-uglify": "^1.5.2"
-  }
+  },
+  "dependencies": {}
 }

index.html

@@ -3,7 +3,7 @@
   /**
    * Check for previous data in localStorage
    */
-  let previousStorage = window.localStorage.getItem('kappa-js');
+  let previousStorage = localStorage.getItem('kappa-js');
 
   /**
    * Initialize KappaJS
@@ -27,7 +27,7 @@
     $.get('https://twitchemotes.com/api_cache/v2/global.json',
       (data) => {
         if(typeof Storage !== 'undefined')
-          window.localStorage.setItem('kappa-js', JSON.stringify(data));
+          localStorage.setItem('kappa-js', JSON.stringify(data));
 
         res(data);
       });
@@ -41,7 +41,7 @@
     init().then((data) => {
       window.KappaJS = data;
     });
-  } else window.KappaJS = JSON.parse(window.localStorage.getItem('kappa-js'));
+  } else window.KappaJS = JSON.parse(localStorage.getItem('kappa-js'));
 
 
   /**