awesome-qr-node v0.1.0

Awesome-qr Node

This is a forked and modified version of Awecome-qr.js, which is an awesome QR code generator written in JavaScript. The modification is to make this library be great to work with Node.js instead of web browser environments (this version is NOT for browsers, please use the original version in order to use in web browsers).

Functionalities are alomst identical to the original implementation, except for:

• Animated GIF is not yet implemented.
• Generator is rely on Node-Canvas, which relys on Cairo imaging library.
• Instead of data: URI string, it returns PNG encoded image buffers.

Usage

const AwesomeQRCode = require('awesome-qr-node');

AwesomeQRCode.create({
  // Parameters here ...
});

// ... or as a promise

AwesomeQRCode.createPromise({
  // Parameters here ...
}).then(function(buffer) {
  // ...
});

Please refer to original documentation for parameters usage.

Installation

Please follow the installation instructions for Node Canvas before installing this module or it will sucks.

You can install with NPM:

$ npm i awesome-qr-node

Copyright & License

© 2017 Jeremy Lam "JLChnToZ"
© 2017 Sumi Makito

Licensed under Apache License 2.0.

Copyright (c) 2017 Jeremy Lam "JLChnToZ"
Copyright (c) 2017 Sumi Makito, https://www.keep.moe

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

This product make uses following components and here are their licenses:

jquery-qrcode
Copyright (c) 2011 Jerome Etienne, http://jetienne.com

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

QRCode for JavaScript
Copyright (c) 2009 Kazuhiko Arase
URL: http://www.d-project.com/
Licensed under the MIT license:
    http://www.opensource.org/licenses/mit-license.php
The word "QR Code" is registered trademark of 
DENSO WAVE INCORPORATED
    http://www.denso-wave.com/qrcode/faqpatent-e.html