bsplit - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

index.js

@@ -28,3 +28,2 @@ /**
 	}
-	//this.flush();
 }
@@ -31,0 +30,0 @@

package.json

 {
   "name": "bsplit",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A dependency-less binary stream splitter",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "mocha tests"
   },
@@ -24,3 +24,7 @@ "repository": {
   },
-  "homepage": "https://github.com/kalm/bsplit#readme"
+  "homepage": "https://github.com/kalm/bsplit#readme",
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "mocha": "^3.1.0"
+  }
 }

README.md

 # bsplit
 
-A light, dependency-less stream splitter for kalm transports.
+[![bsplit](https://img.shields.io/npm/v/bsplit.svg)](https://www.npmjs.com/package/bsplit)
+[![Build Status](https://travis-ci.org/kalm/bsplit.svg?branch=master)](https://travis-ci.org/kalm/bsplit)
+[![Dependencies Status](https://david-dm.org/kalm/bsplit.svg)](https://www.npmjs.com/package/bsplit)
 
+---
+
+## What
+
+A light, dependency-less binary stream splitter for kalm transports.
+
 It acts like a stream, emitting 'data' events, and implementing 'write' and 'end' functions while splitting payloads by a given character or `\n` by default.
 
-Output is a UINT8 array (easier for internal deserialization).
+Output is a UINT8 array (easier for internal deserialization).
+
+
+## Usage
+
+```node
+const bsplit = require('bsplit');
+
+const socket = net.connect(...);
+const stream = socket.pipe(bsplit());
+stream.on('data', (data) => console.log(String.fromCharCode.apply(null, data)));
+```
+
+Where `bsplit()` can take an argument <UINT8> corresponding to the byte to split on.

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

9911

increased by441.58%

Number of package files

5

increased by66.67%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

28

increased by300%

Worsened metrics

Dev dependency count

2

increased byInfinity%

Lines of code

31

decreased by-3.12%

No dependency changes