diff options
Diffstat (limited to 'vendor/github.com/skip2/go-qrcode/README.md')
| -rw-r--r-- | vendor/github.com/skip2/go-qrcode/README.md | 30 |
1 files changed, 18 insertions, 12 deletions
diff --git a/vendor/github.com/skip2/go-qrcode/README.md b/vendor/github.com/skip2/go-qrcode/README.md index 8281ed3e..0a800b72 100644 --- a/vendor/github.com/skip2/go-qrcode/README.md +++ b/vendor/github.com/skip2/go-qrcode/README.md @@ -18,26 +18,20 @@ A command-line tool `qrcode` will be built into `$GOPATH/bin/`. import qrcode "github.com/skip2/go-qrcode" -- **Create a PNG image:** +- **Create a 256x256 PNG image:** var png []byte png, err := qrcode.Encode("https://example.org", qrcode.Medium, 256) -- **Create a PNG image and write to a file:** +- **Create a 256x256 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:** +- **Create a 256x256 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. +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. ## Documentation @@ -56,10 +50,13 @@ qrcode -- QR Code encoder in Go https://github.com/skip2/go-qrcode Flags: + -d disable QR Code border + -i invert black and white -o string - out PNG file prefix, empty for stdout + out PNG file prefix, empty for stdout -s int - image size (pixel) (default 256) + image size (pixel) (default 256) + -t print as text-art on stdout Usage: 1. Arguments except for flags are joined by " " and used to generate QR code. @@ -71,7 +68,16 @@ Usage: 2. Save to file if "display" not available: qrcode "homepage: https://github.com/skip2/go-qrcode" > out.png + ``` +## Maximum capacity +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. + +## Borderless QR Codes + +To aid QR Code reading software, QR codes have a built in whitespace border. + +If you know what you're doing, and don't want a border, see https://gist.github.com/skip2/7e3d8a82f5317df9be437f8ec8ec0b7d for how to do it. It's still recommended you include a border manually. ## Links |