Categorygithub.com/pschlump/goqrcode
repositorypackage
1.0.6
Repository: https://github.com/pschlump/goqrcode.git
Documentation: pkg.go.dev
Overview
Dependencies
13
Dependents
3

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# README

goqrcode - Go QR Code Generator Library and Command Line Tool

pschlump

This project was cloned because the original author seems to have abandoned it.

Changed command line to work slightly differently.

Implemented .SVG output.

Package goqrcode implements a QR Code encoder.

A QR Code is a matrix (two-dimensional) barcode. Arbitrary content may be encoded, with URLs being a popular choice :)

Each QR Code contains error recovery information to aid reading damaged or obscured codes. There are four levels of error recovery: Low, medium, high and highest. QR Codes with a higher recovery level are more robust to damage, at the cost of being physically larger.

Install

go get -u github.com/pschlump/goqrcode/...

A command-line tool qrcode will be built into $GOPATH/bin/.

Command Line Tool

In the ./qrcode directory there is a command line tool.

$ cd ./qrcode
$ go build
$ ./qrcode -o test1.png "otpauth://totp/www.2c-why.com:[email protected]?secret=4S62BZNFXXSZLCRO&issuer=www.2c-why.com"

Will create test1.png containing the url.

Usage

import qrcode "github.com/pschlump/goqrcode"

  • Create a PNG image:

      var png []byte
  png, err := qrcode.Encode("https://example.org", qrcode.Medium, 256)

  • Create a PNG image and write to a file:

      err := qrcode.WriteFile("https://example.org", qrcode.Medium, 256, "qr.png")

  • Create a PNG image with custom colors and write to file:

      err := qrcode.WriteColorFile("https://example.org", qrcode.Medium, 256, color.Black, color.White, "qr.png")

All examples use the qrcode.Medium error Recovery Level and create a fixed 256x256px size QR Code. The last function creates a white on black instead of black on white QR Code.

The maximum capacity of a QR Code varies according to the content encoded and the error recovery level. The maximum capacity is 2,953 bytes, 4,296 alphanumeric characters, 7,089 numeric digits, or a combination of these.

Links