Merge pull request #27 from varvet/publish-to-npm

Prepare for npm publication

README.md

@@ -25,7 +25,24 @@ Note: while you can use Tiny Autocomplete with a local data source, the pattern
 
 ## Installation
 
-Just include tiny-autocomplete.js after Zepto or jQuery. Include tiny-autocomplete.css and you're good to go!
+### Global installation
+
+If you're not using any package managers, put tiny-autocomplete.js after Zepto or jQuery, include tiny-autocomplete.css, and you're good to go!
+
+### Installing through npm
+
+If you're using npm to manage your dependencies, first install the tiny-autocomplete module:
+
+```javascript
+npm install -s @varvet/tiny-autocomplete
+```
+
+Then require it in your files and activate it after your jQuery or Zepto library, like so:
+
+```javascript
+var $ = require("jquery");
+require("@varvet/tiny-autocomplete")($, window);
+```
 
 ## Demos
 

package.json

@@ -21,6 +21,11 @@
   "keywords": [
     "jquery",
     "zepto",
+    "search-as-you-type",
+    "jquery-plugin",
+    "ecosystem:jquery",
+    "zepto-plugin",
+    "ecosystem:zepto",
     "autocomplete",
     "plugin",
     "extensible"

src/tiny-autocomplete.js

@@ -8,7 +8,8 @@
  * @version 1.0.0
  * @return {object}         Self
  */
-(function(window, $) {
+
+var factory = function($, window) {
   var TinyAutocomplete = function(el, options) {
     var that = this; // This is just to minify better
     that.field = $(el);
@@ -668,6 +669,10 @@
       this.tinyAutocomplete = { settings: d.settings };
     });
   };
+};
 
-  $.tinyAutocomplete = TinyAutocomplete;
-})(window, $);
+if (typeof exports !== "undefined") {
+  module.exports = factory;
+} else {
+  factory($, window);
+}