Create README.md

README.md

@@ -0,0 +1,37 @@
+# vue-websocket
+Websocket handler for VueJS. Support namespaces.
+
+## Usage
+Register the plugin
+```js
+import VueWebsocket from "vue-websocket";
+Vue.use(VueWebsocket);
+```
+
+Use it in your components:
+```html
+<script>
+	export default {
+		
+		methods: {
+		  // Emit the server side
+		  this.$socket.emit("add", { a: 5 });    
+		},
+
+		socket: {
+			// prefix: "/counter/",
+			// namespace: "/counter",
+
+			events: {
+
+				// Similar as this.$socket.on("changed", (msg) => { ... });
+				changed(msg) {
+					console.log("Something changed: " + msg);
+				}
+
+			}
+		}
+	};
+
+</script>
+```