suite-flipper-js - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "suite-flipper-js",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Flipper Class",
   "main": "lib/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "mocha test"
   },
@@ -9,0 +9,0 @@ "browserify": {

README.md

@@ -1,1 +0,34 @@
-# flipper-js
+# suite-flipper-js
+
+Install
+---------
+
+    npm install --save suite-flipper-js
+    
+    
+Usage
+---------
+
+    var flipper = Flipper.create(['bi', 'dummy', 'dummy2']);
+    
+    flipper.isOn('bi'); //true
+    flipper.isOn('notInTheList'); //false
+    flipper.isOff('bi'); //false
+    flipper.isOff('notInTheList'); //true
+    
+    
+Usage from api response
+---------
+    
+    var flipper = Flipper.createForApiResponse([
+      { id: 'bi', isOn: true },
+      { id: 'dummy', isOn: true },
+      { id: 'dummy2', isOn: false }
+    ]);
+    
+    flipper.isOn('bi'); //true
+    flipper.isOn('dummy2'); //false
+    flipper.isOn('notInTheList'); //false
+    flipper.isOff('bi'); //false
+    flipper.isOff('dummy2'); //true
+    flipper.isOff('notInTheList'); //true

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4774

increased by17.41%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

35

increased by1650%

No dependency changes