- commit
- 6f3da5a5590054535a1255468ab12e437e99f36d
- parent
- 5f6c90a0d01a812aac1528e528536a902d5b2825
- Author
- Asa <tfh@skip.org>
- Date
- 2015-03-14 19:36
Create README.md
Diffstat
| A | README.md | 40 | ++++++++++++++++++++++++++++++++++++++++ |
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md
@@ -0,0 +1,40 @@
-1 1 # go-qrcode #
-1 2
-1 3 <img src='https://skip.org/img/nyancat-youtube-qr.png' align='right'>
-1 4
-1 5 Package qrcode implements a QR Code encoder.<br>
-1 6 <br>
-1 7 A QR Code is a matrix (two-dimensional) barcode. Arbitrary content may be encoded, with URLs being a popular choice :)<br>
-1 8 <br>
-1 9 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.<br>
-1 10 <br>
-1 11 <h1>Usage</h1>
-1 12 <pre>import qrcode "skip.org/go/qrcode"
-1 13 </pre>
-1 14
-1 15 <ul><li><b>Create a PNG image:</b><pre>var png []byte
-1 16 png, err := qrcode.Encode("https://example.org", qrcode.Medium, 256)
-1 17 </pre></li></ul>
-1 18
-1 19 <ul><li><b>Create a PNG image and write to a file:</b>
-1 20 <pre>err := qrcode.WriteFile("https://example.org", qrcode.Medium, 256, "qr.png")
-1 21 </pre></li></ul>
-1 22
-1 23 Both examples use the <code>qrcode.Medium</code> error Recovery Level and create a 256x256 pixel, black on white QR Code.<br>
-1 24 <br>
-1 25 The maximum capacity of a QR Code varies according to the content encoded and<br>
-1 26 the error recovery level. The maximum capacity is 2,953 bytes, 4,296<br>
-1 27 alphanumeric characters, 7,089 numeric digits, or a combination of these.<br>
-1 28 <br>
-1 29 <h1>Documentation</h1>
-1 30
-1 31 <a href='https://godoc.org/code.google.com/p/go-qrcode'><img src='https://godoc.org/github.com/skip2/go-qrcode?status.png' /></a>
-1 32
-1 33 <h1>Demoapp</h1>
-1 34 <a href='http://go-qrcode.appspot.com'>http://go-qrcode.appspot.com</a>
-1 35
-1 36 <h1>Links</h1>
-1 37
-1 38 <ul><li><a href='http://en.wikipedia.org/wiki/QR_code'>http://en.wikipedia.org/wiki/QR_code</a>
-1 39 </li><li><a href='http://www.iso.org/iso/catalogue_detail.htm?csnumber=43655'>ISO/IEC 18004:2006</a> - Main QR Code specification (approx CHF 198,00)<br>
-1 40 </li><li><a href='https://github.com/qpliu/qrencode-go/'>https://github.com/qpliu/qrencode-go/</a> - alternative Go QR encoding library based on <a href='https://github.com/zxing/zxing'>ZXing</a>