razorframe - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "razorframe",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A real-time database streaming library.",
@@ -5,0 +5,0 @@ "main": "./lib/Razorbrain.js",

README.md

@@ -1,10 +0,94 @@
-# razorframe
-Node library to empower real-time, streaming databases 
+# razorframe<sup>(beta)</sup>  
+####*Empowering real-time databases in Node.js*
+____________________________________________________________________  
 
-```   
-by {  
-  .travis huff  
-  .eddie park  
-  .michael sotkin  
-}
-```   
+###Description  
+Razorframe is a Javascript library built on Node.js which enables developers to build a real-time client experience while maintaining traditional database implementations such as SQL.  
+  
+We use a messaging queue, called a razorframe, that intercepts incoming user interactions over a two-way socket channel.  Those interactions are held in the queue only as long as the server needs before dequeuing.  The dequeuing process then triggers an event that both updates the client UI and launches an asynchronous back-end process such as a database write.  
+
+Our tests have shown this process keeps the client UI updating in sub 100ms "real-time" fashion at scale while maintaining accurate database writes.
+
+###Installation
+Using npm:  
+
+```
+$ npm i --save razorframe
+```
+
+###Example
+**server.js:**  
+
+```
+const rz = require('razorframe');
+
+/**
+ * NEURON parameters - passes into rb any user-defined callbacks
+ * @param - {Object} http => instantiate an http server
+ * @param - {Function} write => a DB write callback (user-defined)
+ * @param - {Function} show => a DB pull callback (user-defined)
+ */
+const NEURON = {
+  write: addToDb,
+  show: showAll,
+};
+
+/**
+ * Instantiate razorframe passing in Node's http object
+ * (to connect with your server) as well as the Neuron object
+ * which contains all the user-defined callbacks
+ */
+rz(http, NEURON);
+```
+
+
+**client.html:**  
+
+```
+<script src="/socket.io/socket.io.js"></script>
+```
+
+**client.js:**  
+
+```
+const socket = io();
+
+/**
+ * MSG parameters
+ * @param {string} MSG.contents => the message value 
+ * @param {string} MSG.eventOut => the outbound event name
+ * @param {string} MSG.channel => the channel name 
+ */
+textForm.addEventListener('submit', (e) => {
+    e.preventDefault();
+
+    const contents = textInput.value;
+    const eventOut = 'msgSent';
+    const channel = 'message-channel';
+    
+    socket.emit('msgSent', { contents, eventOut, channel });
+    textInput.value = '';
+});
+```
+###Platform
+[Node.js](https://nodejs.org/)  
+
+###Dependencies
+[Socket.io](https://www.npmjs.com/package/socket.io)  
+
+
+###Authors  
+[Travis Huff]([e-mail])  
+[Eddie Park]([e-mail])  
+[Michael Sotkin]([e-mail])
+
+###Support  
+Tested in Chrome 55 & Node 6.  
+GitHub Issues: <https://github.com/team-emt/razorframe/issues>
+
+###Contributions
+❤️Contributions welcome!  
+Please see out GitHub repo at: <https://github.com/team-emt/razorframe>
+
+###License  
+[MIT](https://github.com/travishuff/razorframe/blob/master/LICENSE)   

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7135

increased by55.11%

Number of lines in readme file

95

increased by763.64%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes