wsobserver - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

package.json

 {
   "name": "wsobserver",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "websocket client used in electron main process,pub/sub message in render process",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 ##wsobserver
+A node module for receive websocket message in electron main process,and routing  to render process.
 
-websocket client for Electron applications.
+## Introduction
 
-we use wsobserver module in electron main process,wsobserver use thrid party module to connect remote websocket server.
+In electron main process start a websocket client, use thrid party module to connect remote websocket server.
 
-Electron render process receive websocket message from Electron main process throught wsobserver module.we only to add render page's webcontent into wsobserver.
+If Electron render process want to  receive websocket message from Electron main process, must subscribe title and ipc channel throught wsobserver module.we only to add render page's webcontent into wsobserver.
 
-		
+##Install
+	npm install wsobserver --save
+	
 ##Usage
-    npm install wsobserver --save
-
 Require the module in an Electron web page.
@@ -17,25 +18,30 @@
 
-### Electron main process
-#### set up gloabl object
-	
-	//share object in render process and main process
-	 global.sharedObj.wsObserver =wswrap.observer;
+##UsageAPI
 
-####websocket usage
- open a websocket client:
-	
-    var ws = new wswrap.wsclient('ws://localhost:8088');
-    ws.ws_connect();
-    
- open a websocket client:
+**subscribe(object, title, ipc_name)**
 
-	ws.ws_sendmsg('hello server');
+object:Electron's BrowserWindow property webContent, 
+title:string, ipc_name:string
 
- close a websocket client:
+**unsubscribe(object, title)**
 
-	ws.ws_stop();
+object:Electron's BrowserWindow property webContent,  title:string
 
+**unsubscribeAll(object)**
+object:Electron's BrowserWindow property webContent
 
-### Electron render process
+**send(title, data)**
 
+title:string, data:string
+
+### In main process
+	
+	//share object in render process and main process
+	global.sharedObj.wsObserver =wswrap.observer;
+    
+	var ws = new wswrap.wsclient('ws://localhost:8088');
+    ws.ws_connect();
+
+### In render process
+
     var ipcRenderer = require('electron').ipcRenderer;
@@ -42,0 +48,0 @@ var remote = require('electron').remote;

No alert changes

Improved metrics

Total package byte prevSize

7754

increased by3.97%

Number of lines in readme file

64

increased by10.34%

No dependency changes