aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/boombuler/barcode/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/boombuler/barcode/README.md')
-rw-r--r--vendor/github.com/boombuler/barcode/README.md49
1 files changed, 42 insertions, 7 deletions
diff --git a/vendor/github.com/boombuler/barcode/README.md b/vendor/github.com/boombuler/barcode/README.md
index 85c34d6390..2a988db399 100644
--- a/vendor/github.com/boombuler/barcode/README.md
+++ b/vendor/github.com/boombuler/barcode/README.md
@@ -1,18 +1,53 @@
-##Introduction##
+[![Join the chat at https://gitter.im/golang-barcode/Lobby](https://badges.gitter.im/golang-barcode/Lobby.svg)](https://gitter.im/golang-barcode/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+## Introduction ##
+
This is a package for GO which can be used to create different types of barcodes.
-##Supported Barcode Types##
+## Supported Barcode Types ##
+* 2 of 5
* Aztec Code
* Codabar
* Code 128
* Code 39
-* EAN 8
-* EAN 13
+* Code 93
* Datamatrix
-* QR Codes
-* 2 of 5
+* EAN 13
+* EAN 8
+* PDF 417
+* QR Code
+
+## Example ##
+
+This is a simple example on how to create a QR-Code and write it to a png-file
+```go
+package main
+
+import (
+ "image/png"
+ "os"
+
+ "github.com/boombuler/barcode"
+ "github.com/boombuler/barcode/qr"
+)
+
+func main() {
+ // Create the barcode
+ qrCode, _ := qr.Encode("Hello World", qr.M, qr.Auto)
+
+ // Scale the barcode to 200x200 pixels
+ qrCode, _ = barcode.Scale(qrCode, 200, 200)
+
+ // create the output file
+ file, _ := os.Create("qrcode.png")
+ defer file.Close()
+
+ // encode the barcode as png
+ png.Encode(file, qrCode)
+}
+```
-##Documentation##
+## Documentation ##
See [GoDoc](https://godoc.org/github.com/boombuler/barcode)
To create a barcode use the Encode function from one of the subpackages.