socketcluster-client - npm Package Compare versions

Comparing version 0.9.8 to 0.9.9

package.json

 {
   "name": "socketcluster-client",
   "description": "Client side of SocketCluster",
-  "version": "0.9.8",
+  "version": "0.9.9",
   "homepage": "https://github.com/topcloud/socketcluster-client",
@@ -6,0 +6,0 @@ "contributors": [

README.md

@@ -1,7 +0,55 @@
-# SocketCluster client
+SocketCluster Client
+======
 
-To build, use:
+SocketCluster Client is the client-side component of SocketCluster.
 
+To install, run:
+
+```bash
+npm install socketcluster-client
 ```
+
+The socketcluster-client script is called socketcluster.js (located in the main socketcluster-client directory) 
+- You should include it in your HTML page using a <script> tag in order to interact with SocketCluster.
+
+SocketCluster Client was created using component (client package manager).
+To build it (outputs to socketcluster.js), use:
+
+```
 component build -s socketCluster -n socketcluster -o .
+```
+
+## How to use
+
+Embed in your HTML page using (Note that the src attribute may be different depending on how you setup your HTTP server):
+
+```html
+<script type="text/javascript" src="/socketcluster.js"></script>;
+```
+
+Once you have embedded the client socketcluster.js into your page, you will gain access to a global socketCluster object.
+Then, to begin interacting with the SocketCluster cluster, you will need to establish a connection.
+Once that's done, you will be able to emit events to the server and listen to incoming events (sample code):
+
+```js
+var options = {
+	protocol: location.protocol.replace(/:$/, ''),
+	hostname: location.hostname,
+	port: 8000,
+	autoReconnect: true
+};
+
+// Initiate the connection to the server
+var socket = socketCluster.connect(options);
+socket.on('connect', function () {
+	console.log('CONNECTED');
+});
+
+// Listen to an event called 'rand' from the server
+socket.on('rand', function (num) {
+	console.log('RANDOM: ' + num);
+	var curHTML = document.body.innerHTML;
+	curHTML += 'RANDOM: ' + num + '<br />';
+	document.body.innerHTML = curHTML;
+});
 ```

No alert changes

Improved metrics

Total package byte prevSize

172276

increased by2.88%

Number of lines in readme file

55

increased by685.71%

No dependency changes