qr-min 0.0.2 → 1.0.0

package/README.md

@@ -8,7 +8,72 @@
 Minimal implementation to generate a QR code from a UTF-8 string.  
 This is all you need for 99.9% of applications.
 
-Pure JavaScript. No dependencies.
+Pure JavaScript. No dependencies. Works in browser and Node.js.
 
 If you need finer control over QR code generation,  
-please check https://github.com/nayuki/QR-Code-generator
+please check https://github.com/nayuki/QR-Code-generator
+
+## Usage
+
+##### Plain HTML
+
+```html
+<script src="qr-min.js"></script>
+```
+
+##### CDN (jsdelivr)
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/qr-min"></script>
+```
+
+##### CDN (unpkg)
+
+```html
+<script src="https://unpkg.com/qr-min"></script>
+```
+
+##### Node.js
+
+```js
+const QR = require('qr-min');
+```
+
+## API
+
+`QR(...)` - the only function in this package.
+Takes a string and returns a 2-dimensional array of the dots in the QR code.  
+Use this data to produce an image in your own artistic style.
+
+##### Example
+```js
+const QR = require('qr-min');
+const qr = QR('https://github.com/jazz-soft/qr-min');
+var i, j, s = '';
+for (i = 0; i < qr.length; i += 2) {
+    for (j = 0; j < qr.length; j++) s += i + 1 < qr.length && qr[i + 1][j] ? qr[i][j] ? '█' : '▄' : qr[i][j] ? '▀' : ' ';
+    s += '\n';
+}
+console.log(s);
+```
+This will produce the following output:
+```
+█▀▀▀▀▀█  ▄▀  ▄▀  ▀ █  █▀▀▀▀▀█
+█ ███ █ ▀▄ ▀▄▄ ▀  ▀▀█ █ ███ █
+█ ▀▀▀ █  ▀▄▄█▀▄▄▀███▄ █ ▀▀▀ █
+▀▀▀▀▀▀▀ █ ▀▄▀ ▀ █▄█▄▀ ▀▀▀▀▀▀▀
+█▀▀▄██▀▀█▄ ▄█▄ ▀██▄ █▀█  ▄▀ ▄
+█ ▄ █▄▀ ▄▄█▀█▄█▄ ██ ▀▀▀▄█ ▀█▀
+█▄ ▄ █▀▀  ██  █▀█▀ ▀███  █ ▀█
+▀█▀█▄▀▀█▄ ▀▄ ▀ ▄▄█▄ ▄▄█ ▀█ █▀
+  █▄▀█▀  ▄ ▄█▄ ▀██ ▀▀▄█▀ █▄▀█
+▀▄▄▄ █▀ ▄▀ ▀█▄█▄▄█ ▄▄█▄██▄ █▀
+▀  ▀  ▀ ▄▀██  █▀▀█▄██▀▀▀█ ▄▄▄
+█▀▀▀▀▀█ █ █▄ ▀  ▀▄ ▀█ ▀ ██ ▀█
+█ ███ █ ▀▀█▄█▄  ▄▀▀ █▀▀██ ▄▄█
+█ ▀▀▀ █ █▄ ▀█▄█▄ █▄█▄▄ ▀█▀ ▄▀
+▀▀▀▀▀▀▀ ▀▀▀▀  ▀  ▀ ▀▀▀ ▀▀  ▀▀
+```
+Sorry, it doesn’t look very impressive in the Markdown document, but it works nevertheless! :)
+
+See more examples of generating SVG and Canvas images in this repository.

package/javascript/qr-min.js

@@ -143,6 +143,17 @@
       }
     }
     d[sz - 8][8] = 1;
+    if (v > 6) {
+      m = v;
+      for (k = 0; k < 12; k++) m = (m << 1) ^ ((m >>> 11) * 0x1F25);
+      m = v << 12 | m;
+      for (k = 0; k < 18; k++) {
+        i = sz - 11 + k % 3;
+        j = Math.floor(k / 3);
+        d[i][j] = (m & (1 << k)) >>> k;
+        d[j][i] = (m & (1 << k)) >>> k;
+      }
+    }
   }
   function _res(v) {
     var i, j, k, m, sz = v * 4 + 17, e = _eyes(v);
@@ -168,6 +179,10 @@
         r[e[k] + i - 2][e[m] + j - 2] = 1;
       }
     }
+    if (v > 6) for (i = 0; i < 6; i++) for (j = 0; j < 3; j++) {
+      r[i][sz - j - 9] = 1;
+      r[sz - j - 9][i] = 1;
+    }
     return r;
   }
   function _format(d, c, m) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qr-min",
-  "version": "0.0.2",
+  "version": "1.0.0",
   "description": "Minimal implementation to generate a QR code from a UTF-8 string",
   "main": "javascript/qr-min.js",
   "scripts": {

package/test/mocha.js

@@ -1,48 +0,0 @@
-var assert = require('assert');
-var QR = require('..');
-
-function text(qr) {
-  var i, j, s = '';
-  for (i = 0; i < qr.length; i += 2) {
-      for (j = 0; j < qr.length; j++) s += i + 1 < qr.length && qr[i + 1][j] ? qr[i][j] ? '█' : '▄' : qr[i][j] ? '▀' : ' ';
-      s += '\n';
-  }
-  return s;
-}
-
-describe('qr', function() {
-  it('short', function() {
-    assert.equal(text(QR('a')),`
-█▀▀▀▀▀█  █▄█▀ █▀▀▀▀▀█
-█ ███ █ ▀█ █▀ █ ███ █
-█ ▀▀▀ █   ▀ █ █ ▀▀▀ █
-▀▀▀▀▀▀▀ █▄▀▄█ ▀▀▀▀▀▀▀
-▀▀█ ██▀█▀▀█▀ ▀█   █▄ 
-▄▄ ▄▀▄▀▀▀██ ▀ ▄ ▀ ▄ ▀
-▀▀  ▀▀▀▀▄▄ ▄▀▄▀▄▀▄▀▄█
-█▀▀▀▀▀█ █▄▄█▄█▀█▄█▀▀▀
-█ ███ █ ▀ █▀ ▀█▀ ▀█▄▀
-█ ▀▀▀ █ ██  ▀ ▄ ▀ ▄▄▀
-▀▀▀▀▀▀▀ ▀▀  ▀ ▀ ▀ ▀▀▀
-`.substring(1));
-  });
-  it('medium', function() {
-    assert.equal(text(QR('https://github.com/jazz-soft/qr-min')),`
-█▀▀▀▀▀█  ▄▀  ▄▀  ▀ █  █▀▀▀▀▀█
-█ ███ █ ▀▄ ▀▄▄ ▀  ▀▀█ █ ███ █
-█ ▀▀▀ █  ▀▄▄█▀▄▄▀███▄ █ ▀▀▀ █
-▀▀▀▀▀▀▀ █ ▀▄▀ ▀ █▄█▄▀ ▀▀▀▀▀▀▀
-█▀▀▄██▀▀█▄ ▄█▄ ▀██▄ █▀█  ▄▀ ▄
-█ ▄ █▄▀ ▄▄█▀█▄█▄ ██ ▀▀▀▄█ ▀█▀
-█▄ ▄ █▀▀  ██  █▀█▀ ▀███  █ ▀█
-▀█▀█▄▀▀█▄ ▀▄ ▀ ▄▄█▄ ▄▄█ ▀█ █▀
-  █▄▀█▀  ▄ ▄█▄ ▀██ ▀▀▄█▀ █▄▀█
-▀▄▄▄ █▀ ▄▀ ▀█▄█▄▄█ ▄▄█▄██▄ █▀
-▀  ▀  ▀ ▄▀██  █▀▀█▄██▀▀▀█ ▄▄▄
-█▀▀▀▀▀█ █ █▄ ▀  ▀▄ ▀█ ▀ ██ ▀█
-█ ███ █ ▀▀█▄█▄  ▄▀▀ █▀▀██ ▄▄█
-█ ▀▀▀ █ █▄ ▀█▄█▄ █▄█▄▄ ▀█▀ ▄▀
-▀▀▀▀▀▀▀ ▀▀▀▀  ▀  ▀ ▀▀▀ ▀▀  ▀▀
-`.substring(1));
-  });
-});