README
¶
go.qrt
Generate QR code's for in your terminal.
go.qrt generates a QR code based on UTF-8 characters. This allow you to display a QR code in your terminal
Install
go get github.com/GeertJohan/go.qrt
Usage example
package main
import (
"fmt"
"github.com/GeertJohan/go.qrt"
)
func main() {
str, err := qrt.Generate("some example text")
if err != nil {
fmt.Println(err)
return
}
fmt.Print(str)
}
Documentation
For more information about the options you can use for QR generation, please check the documentation at godoc.org/github.com/GeertJohan/go.qrt
License
This project is licensed under a Simplified BSD license. Please read the LICENSE file.
Attribution
This package imports and uses code.google.com/p/rsc/qr, a QR generation package by Russ Cox.
Screenshot
Depending on your terminal and font you may need to scan the QR code under an angle to make it appear square for the scanner.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var DefaultConfig = &Config{ UseSGR: true, Level: M, }
DefaultConfig is used by the Generate function You can change it's values, or create a Config instance of your own.
Functions ¶
Types ¶
type Config ¶
type Config struct {
// UseSGR, when true, Generate() uses Select Graphic Rendition (github.com/foize/go.sgr) to force correct colors in the terminal (black/white)
// You should disable this when writing the result to a file
UseSGR bool
// Level indicates the required redudancy level for the generated QR's
// You can keep the redundancy value low because screens are pretty bright and clean.... Or well, they should be.
Level Level
}
Config hold all paramters that can be set with this library
Source Files
Directories