update README | add keywords in package.json

README.md

@@ -1,18 +1,64 @@
-# v-snow
+# V-Snow
 
-> A Vue.js project
+[![Vue2](https://img.shields.io/badge/Vue-2.x-brightgreen.svg?style=for-the-badge)](https://vuejs.org/)
+[![npm](https://img.shields.io/npm/v/vsnow?style=for-the-badge)](https://www.npmjs.com/package/vsnow)
+[![npm](https://img.shields.io/npm/dw/vsnow?style=for-the-badge)](https://www.npmjs.com/package/vsnow)
 
-## Build Setup
+Snowfall effect plugin for Vue js
 
-```bash
-# install dependencies
-npm install
+> ## 👀 Demo
 
-# serve with hot reload at localhost:8080
-npm run dev
+You can play with params on
+[DEMO PAGE](http://gamazu.github.io/v-snow)
 
-# build for production with minification
-npm run build
+> ## 💾 Instalation
+
+This version requires Vue 2.X.
+
+```sh
+npm install vsnow
+```
+
+## Initialization
+
+### ES2015 (Webpack/Rollup/Browserify/etc)
+
+```javascript
+import Vue from "vue";
+import VSnow from "vsnow";
+
+Vue.use(VSnow);
+// Or as a directive-only
+import { VSnowDirective } from "vsnow";
+Vue.directive("v-snow", VSnowDirective);
+// Or only as a component
+import { VSnowContainer } from "vsnow";
+Vue.filter("VSnow", VSnowContainer);
 ```
 
-For detailed explanation on how things work, consult the [docs for vue-loader](http://vuejs.github.io/vue-loader).
+### UMD (Browser)
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/vsnow/dist/vsnow.min.js"></script>
+<script>
+  // As a plugin
+  Vue.use(vsnow.VueMaskPlugin);
+</script>
+```
+
+## 🚀 Usage
+
+```html
+<!-- As a directive -->
+<div v-snow>
+  <!-- content -->
+</div>
+
+<!-- As a wrapper componente -->
+<VSnow />
+```
+
+`That's all 🤩`
+
+## ⚙️ Configuration

package.json

@@ -10,6 +10,11 @@
   "typings": "dist/types/v-snow/index.d.ts",
   "version": "1.0.33",
   "author": "Alexander Burkov <[email protected]>",
+  "keywords": [
+    "snow",
+    "snowfall",
+    "vue"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/gamazu/v-snow"

src/v-snow/index.ts

@@ -21,13 +21,13 @@ export const directive = statefulDirective();
 const plugin: PluginObject<any> = {
   install(Vue) {
     Vue.directive("snow", directive);
-    Vue.component("VueSnow", component);
+    Vue.component("VSnow", component);
   }
 };
 
 // auto install
 if (typeof window !== "undefined" && window.Vue) {
-  plugin.install(window.Vue, {});
+  plugin.install(window.Vue);
   (window as any).vsnow = plugin;
 }