qrloop - npm Package Compare versions

Comparing version 0.4.0 to 0.5.0

lib/exporter.js

@@ -42,3 +42,4 @@ "use strict";
  */
-function dataToFrames(dataOrStr, dataSize) {
+function dataToFrames(dataOrStr) {
+  var dataSize = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 120;
   var replicas = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 1;
@@ -45,0 +46,0 @@

package.json

 {
   "name": "qrloop",
-  "version": "0.4.0",
-  "description": "",
+  "version": "0.5.0",
+  "description": "Envelop big blob of data into frames that can be displayed in series of QR Codes",
+  "keywords": [
+    "buffer",
+    "data",
+    "envelop",
+    "qrcode",
+    "qr"
+  ],
   "main": "lib/index.js",
@@ -22,2 +29,10 @@ "scripts": {
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gre/qrloop"
+  },
+  "bugs": {
+    "url": "https://github.com/gre/qrloop/issues"
+  },
+  "homepage": "https://github.com/gre/qrloop",
   "author": "Gaëtan Renaudeau <[e-mail]>",
@@ -24,0 +39,0 @@ "license": "MIT",

README.md

@@ -1,3 +0,80 @@
-## qrloop
+# qrloop
 
-Encode a big binary blob to a loop of QR codes.
+Envelop big blob of data into frames that can be displayed in series of QR Codes.
+
+![example](https://user-images.githubusercontent.com/211411/46581095-0c663300-ca32-11e8-8366-5d4205a6e14f.gif)
+
+> NB. this library is generic enough to not even be used with QR Codes but still take optimization decision in regard to how QR code works and from empirical tests.
+
+## Install
+
+### for Web or Electron
+
+```
+yarn add qrloop
+```
+
+### for React Native
+
+```
+yarn add qrloop
+yarn add buffer   # required
+```
+
+## API
+
+There are 2 parts of the library, the "exporter" that want to export the data via QR codes and the "importer" that will scan these QR codes and accumulate the frames until it reaches the final result.
+
+### exporter
+
+The exporter only have 1 function to use: `dataToFrames`.
+
+```js
+import { dataToFrames } from "qrloop/exporter";
+
+// examples
+const frames: string[] = dataToFrames("hello world");
+const frames = dataToFrames(Buffer.from([ 0x00, 0x01, ... ]));
+const frames = dataToFrames(data, 140, 2);
+
+// dataToFrames( data[, dataSize, replicas ])
+// data: the complete data to encode in a series of QR code frames
+// dataSize: the number of bytes to use from data for each frame
+// replicas: (>= 1) the total number of loops to repeat the frames with varying a nonce. More there is, better the chance to not be stuck on a frame. Experience has shown some QR Code are harder to read.
+```
+
+You can find an implementation example in [`examples/web-text-exporter`](examples/web-text-exporter).
+
+### importer
+
+There are a few functions you can use to be able to consume and accumulate the frames over time.
+
+The main function is `parseFramesReducer` that you feed with each QR Code data and will accumulate a state. Consider that state a black box and prefer using the utility functions to extract out information.
+
+```js
+import {
+  parseFramesReducer,
+  areFramesComplete,
+  framesToData,
+  progressOfFrames
+} from "qrloop/importer";
+
+const onResult = finalResult => console.log({ finalResult });
+
+let frames = null;
+
+const onBarCodeScanned = (data: string) => {
+  try {
+    frames = parseFramesReducer(this.frames, data);
+    if (areFramesComplete(frames)) {
+      onResult(framesToData(frames).toString());
+    } else {
+      console.log("Progress:", progressOfFrames(frames));
+    }
+  } catch (e) {
+    console.warn(e); // a qrcode might fail. maybe the data is corrupted or you scan something that is not relevant.
+  }
+};
+```
+
+You can find an implementation example in [`examples/rn-text-importer`](examples/rn-text-importer).

src/exporter.js

@@ -34,3 +34,3 @@ // @flow
   dataOrStr: Buffer,
-  dataSize: number,
+  dataSize: number = 120,
   replicas: number = 1
@@ -37,0 +37,0 @@ ): string[] {

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 bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

49537

increased by6.37%

Lines of code

487

increased by0.21%

Number of low maintenance alerts

0

decreased by-100%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

81

increased by1925%

Number of low supply chain risk alerts

0

decreased by-100%

No dependency changes