Add: README add usage info

This commit is contained in:
Phantas Weng 2019-12-02 17:25:43 +08:00
parent 0c68c515df
commit 12d719b022

View file

@ -82,6 +82,7 @@ new Vue({
**Parameters**|**Type's**|**Default**|**Required**|**Description** **Parameters**|**Type's**|**Default**|**Required**|**Description**
-----|-----|-----|-----|----- -----|-----|-----|-----|-----
debug|Boolean|`false`|Optional|Enable logging for debug debug|Boolean|`false`|Optional|Enable logging for debug
darkMode|Boolean|`false`|Optional|Enable console dark mode for debug
connection|String/Socket.io-client|`null`|Required|Websocket server url or socket.io-client instance connection|String/Socket.io-client|`null`|Required|Websocket server url or socket.io-client instance
vuex.store|Vuex|`null`|Optional|Vuex store instance vuex.store|Vuex|`null`|Optional|Vuex store instance
vuex.actionPrefix|String|`null`|Optional|Prefix for emitting server side vuex actions vuex.actionPrefix|String|`null`|Optional|Prefix for emitting server side vuex actions