@fanoutio/grip - npm Package Compare versions

Comparing version 2.0.0-rc.2 to 2.0.0

package.json

 {
   "name": "@fanoutio/grip",
-  "version": "2.0.0-rc.2",
+  "version": "2.0.0",
   "author": "Fanout, Inc. <[e-mail]>",
@@ -5,0 +5,0 @@ "description": "GRIP Interface Library",

README.md

@@ -10,2 +10,8 @@ # GRIP Interface Library for JavaScript
 
+## Installation
+
+```sh
+npm install @fanoutio/grip
+```
+
 ## Sample Usage
@@ -16,4 +22,4 @@
 ```javascript
-var pubcontrol = require('pubcontrol');
-var grip = require('grip');
+var pubcontrol = require('@fanoutio/pubcontrol');
+var grip = require('@fanoutio/grip');
 
@@ -76,3 +82,3 @@ var callback = function(success, message, context) {
 var http = require('http');
-var grip = require('grip');
+var grip = require('@fanoutio/grip');
 
@@ -105,3 +111,3 @@ http.createServer(function (req, res) {
 var http = require('http');
-var grip = require('grip');
+var grip = require('@fanoutio/grip');
 
@@ -144,4 +150,4 @@ http.createServer(function (req, res) {
 var ws = require("nodejs-websocket")
-var pubcontrol = require('pubcontrol');
-var grip = require('grip');
+var pubcontrol = require('@fanoutio/pubcontrol');
+var grip = require('@fanoutio/grip');
 
@@ -170,4 +176,4 @@ ws.createServer(function (conn) {
 var http = require('http');
-var pubcontrol = require('pubcontrol');
-var grip = require('grip');
+var pubcontrol = require('@fanoutio/pubcontrol');
+var grip = require('@fanoutio/grip');
 
@@ -221,3 +227,3 @@ http.createServer(function (req, res) {
 ```javascript
-var grip = require('grip');
+var grip = require('@fanoutio/grip');
 var config = grip.parseGripUri('http://api.fanout.io/realm/<myrealm>' +
@@ -227,2 +233,32 @@ '?iss=<myrealm>&key=base64:<myrealmkey>');
 
+## Consuming this library
+
+### CommonJS
+
+The CommonJS version of this package requires Node v8 or newer.
+
+Require in your JavaScript:
+
+```javascript
+const grip = require('@fanoutio/grip');
+const grippub = new grip.GripPubControl({control_uri: "<endpoint_uri>"});
+```
+
+If you are building a bundle, you may also import in your JavaScript.
+
+```javascript
+import grip from '@fanoutio/grip';
+const pub = new grip.GripPubControl({control_uri: "<endpoint_uri>"});
+```
+
+This package comes with full TypeScript type definitions, so you may use it with
+TypeScript as well.
+
+```javascript
+import grip, { IHoldInstruction } from '@fanoutio/grip';
+const pub = new grip.GripPubControl({control_uri: "<endpoint_uri>"});
+
+// IHoldInstruction is a type declaration.
+```
+
 ### Demo
@@ -229,0 +265,0 @@

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1463422

increased by0.06%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

299

increased by13.69%

No dependency changes