diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 0001751..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 066b2d9..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/README.md b/README.md index 968852a..de98000 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@
-Vue-Socket.io is a socket.io integration for Vuejs, easy to use, supporting Vuex and component level socket consumer managements.
+
Vue-Socket.io is a socket.io integration for Vuejs, easy to use, supporting Vuex and component level socket consumer managements
###### Demo - Chat Application @@ -33,7 +33,6 @@ import Vue from 'vue' import store from './store' import App from './App.vue' import VueSocketIO from 'vue-socket.io' -import SocketIO from "socket.io-client" Vue.use(new VueSocketIO({ debug: true, @@ -59,7 +58,6 @@ import Vue from 'vue' import store from './store' import App from './App.vue' import VueSocketIO from 'vue-socket.io' -import SocketIO from "socket.io-client" const options = { path: '/my-app/' }; //Options object to pass into SocketIO @@ -88,7 +86,6 @@ connection|String/Socket.io-client|`null`|Required|Websocket server url or socke vuex.store|Vuex|`null`|Optional|Vuex store instance vuex.actionPrefix|String|`null`|Optional|Prefix for emitting server side vuex actions vuex.mutationPrefix|String |`null`|Optional|Prefix for emitting server side vuex mutations -vuex.options.useConnectionNamespace |Boolean|`false`|Optional|Use more than one connection namespace #### 🌈 Component Level Usage @@ -149,41 +146,6 @@ export default new Vuex.Store({ }) ``` -#### 🏆 Connection Namespace -
When you need to handle more than one namespaced connection, you need to set the `useConnectionNamespace` property of -the options object to true. What this does is telling the plugin that you are going to be using more than one namespaced connection and you want to put every connection in their own `$socket` key.
- -``` javascript -import Vue from 'vue' -import store from './store' -import App from './App.vue' -import VueSocketIO from 'vue-socket.io' - -Vue.use(new VueSocketIO({ - debug: true, - connection: 'http://metinseylan.com:1992/mynamespace', - vuex: { - store, - options: { - useConnectionNamespace: true - } - }, - options: { path: "/my-app/" } //Optional options -})) - -new Vue({ - router, - store, - render: h => h(App) -}).$mount('#app') -``` - -Then use it like this: - -``` javascript -Vue.$socket.mynamespace.emit('emit_method', data) -``` - ## Stargazers over time [![Stargazers over time](https://starcharts.herokuapp.com/MetinSeylan/Vue-Socket.io.svg)](https://starcharts.herokuapp.com/MetinSeylan/Vue-Socket.io) diff --git a/dist/vue-socketio.js b/dist/vue-socketio.js index 595a9ef..504c329 100644 --- a/dist/vue-socketio.js +++ b/dist/vue-socketio.js @@ -5,6 +5,6 @@ * @author Feross Aboukhadijeh