https://github.com/fsh-org/rmqr

Rectangular Micro QR code generator for node
https://github.com/fsh-org/rmqr

fsh generator rmqr rmqrcode rmqrcode-generator

Last synced: 2 days ago
JSON representation

Rectangular Micro QR code generator for node

• Host: GitHub
• URL: https://github.com/fsh-org/rmqr
• Owner: fsh-org
• Created: 2024-07-29T07:31:06.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-08-25T13:49:38.000Z (3 months ago)
• Last Synced: 2024-09-26T15:11:01.291Z (about 2 months ago)
• Topics: fsh, generator, rmqr, rmqrcode, rmqrcode-generator
• Language: JavaScript
• Homepage: https://npmjs.com/package/rmqr
• Size: 12.7 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# rMQR

This package allows you to create rMQRs (Rectangular Micro QR)

## Usage

Some basic usage of the package.

```js

const { rmqr } = require('rmqr');

console.log(rmqr.generate('Some text'))

```

This will return an object with a width, height and a 2d array.

You can also generate a image and adjust some settings

```js

const { rmqr, strategy, correction } = require('rmqr');

let data = rmqr.generate('Other text', {

  strategy: strategy.minHeight, // Options: balanced, min-height, minHeight, min-width, minWidth

  correction: correction.high // Options: auto, medium, high (high has a lower max characters)

})

console.log(rmqr.toImage(data, 'jpg', 'uri', 10))

/*

1st the object from the generate

2nd argument is a image extension (png, jpg, jpeg, webp, tiff...)

3rd is the way the data will be presented (buffer or uri)

4th number of pixels per color

*/

```