jsynchronous 0.9.2 → 0.9.5

package/README.md

@@ -1,10 +1,10 @@
 # Jsynchronous.js
 
-Get your (rapidly changing) data from Node.js->Browser with ease. 
+Synchronize your rapidly changing app state with all connected browsers.
 
-Jsynchronous is a real-time data synchronization library. Fast enough for games, flexible enough for science, and tested to precision. Can also handle server->server sync or browser->server sync. 
+Jsynchronous ensures all clients see the same data as what’s on your server - even as it changes. Fast enough for games, flexible enough for graph applications, and tested to precision.
 
-Create an array or object in Node.js. Jsynchronous will create an identical variable in connected browsers:
+Register an ordinary javascript array or object with jsynchronous on your Node.js server and an identical copy will become available on connected browsers:
 
 ```javascript
 // Server side
@@ -47,9 +47,13 @@ data.circular.a.b.c = data.circular;
 
 const $ynced = jsynchronous(data);
 ```
+ 
+Jsynchronous can also handle server->server sync, or (experimentally) browser->server sync.
 
 # Setting up
 
+Follow the [example code snippets](https://github.com/siriusastrebe/jsynchronous/tree/master/examples) for easy integration.
+
 Jsynchronous does not lock you into a transportation medium you use whether it be [socket.io](https://socket.io/) [ws](https://www.npmjs.com/package/ws) [Primus](https://www.npmjs.com/package/primus), [EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource), or [webRTC](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API). Any protocol with eventual in-order delivery works. We will be using [ws](https://www.npmjs.com/package/ws) in this example.
 
 The server side setup consists of 3 required steps:
@@ -169,7 +173,7 @@ const ws = new WebSocket('ws://localhost:8080');
 ws.onmessage = (data) => jsynchronous.onmessage(data.data);
 jsynchronous.send = (data) => ws.send(data);
 
-$ynced = jsynchronous('object');
+const $ynchronized = jsynchronous('object');
 ```
 
 Setting up client->server communication makes your synchronized variables resistant to data loss and desynchronization. By default the client will give you a warning if you don't provide .send on client or .onmessage on server and will halt if messages are missed and no re-synchronization is possible.

package/jsynchronous-client.js

@@ -62,7 +62,7 @@ function jsynchronousSetup() {
         if (jsynchronous.send) {
           var uniqueId = 'initial' + name;
           communicateWithBackoff(uniqueId, ['initial', name], function () {
-console.log('Unknown jsynchronous variable, requesting initial' + name);
+            console.log('Unknown jsynchronous variable, requesting initial' + name);
             return jsyncs[name] === undefined;
           }, 2000);
         } else {
@@ -666,11 +666,6 @@ console.log('Unknown jsynchronous variable, requesting initial' + name);
 
   function addSynchronizedVariableMethods(jsync, targetVariable, reservedWords) {
     // targetVariable will be details.variable if it's synced. Otherwise it should be a stand-in variable
-    for (var key in clientReservedWords) {
-      if (typeof targetVariable[key] === 'function') {
-        delete targetVariable[key];
-      }
-    }
     if (reservedWords === undefined) reservedWords = {}
     for (var key in clientReservedWords) { 
       if (!reservedWords[key]) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsynchronous",
-  "version": "0.9.2",
+  "version": "0.9.5",
   "author": "Sirius Strebe <siriusastrebe@gmail.com> (http://asksiri.us)",
   "repository": {
     "type": "git",
@@ -26,12 +26,7 @@
   "homepage": "https://github.com/siriusastrebe/jsynchronous#readme",
   "main": "jsynchronous.js",
   "directories": {
-    "example": "examples",
-    "test": "tests"
-  },
-  "dependencies": {
-    "express": "^4.17.1",
-    "socket.io": "^4.1.3",
-    "socketio": "^1.0.0"
+    "examples": "examples",
+    "tests": "tests"
   }
 }