|
| 1 | +## About |
| 2 | + |
| 3 | +QRCoder is a simple library, written in C#.NET, which enables you to create QR codes. It hasn't any dependencies to other libraries and is available as .NET Framework and .NET Core PCL version on NuGet. |
| 4 | + |
| 5 | +*** |
| 6 | + |
| 7 | +## Documentation |
| 8 | + |
| 9 | +👉 *Your first place to go should be our wiki. Here you can find a detailed documentation of the QRCoder and its functions.* |
| 10 | +* [**QRCode Wiki**](https://github.com/codebude/QRCoder/wiki) |
| 11 | +* [Creator's blog (english)](http://en.code-bude.net/2013/10/17/qrcoder-an-open-source-qr-code-generator-implementation-in-csharp/) |
| 12 | +* [Creator's blog (german)](http://code-bude.net/2013/10/17/qrcoder-eine-open-source-qr-code-implementierung-in-csharp/) |
| 13 | + |
| 14 | + |
| 15 | +## Usage / Quick start |
| 16 | + |
| 17 | +You only need five lines of code, to generate and view your first QR code. |
| 18 | + |
| 19 | +```csharp |
| 20 | +QRCodeGenerator qrGenerator = new QRCodeGenerator(); |
| 21 | +QRCodeData qrCodeData = qrGenerator.CreateQrCode("The text which should be encoded.", QRCodeGenerator.ECCLevel.Q); |
| 22 | +QRCode qrCode = new QRCode(qrCodeData); |
| 23 | +Bitmap qrCodeImage = qrCode.GetGraphic(20); |
| 24 | +``` |
| 25 | + |
| 26 | +### Optional parameters and overloads |
| 27 | + |
| 28 | +The GetGraphics-method has some more overloads. The first two enable you to set the color of the QR code graphic. One uses Color-class-types, the other HTML hex color notation. |
| 29 | + |
| 30 | +```csharp |
| 31 | +//Set color by using Color-class types |
| 32 | +Bitmap qrCodeImage = qrCode.GetGraphic(20, Color.DarkRed, Color.PaleGreen, true); |
| 33 | + |
| 34 | +//Set color by using HTML hex color notation |
| 35 | +Bitmap qrCodeImage = qrCode.GetGraphic(20, "#000ff0", "#0ff000"); |
| 36 | +``` |
| 37 | + |
| 38 | +The other overload enables you to render a logo/image in the center of the QR code. |
| 39 | + |
| 40 | +```csharp |
| 41 | +Bitmap qrCodeImage = qrCode.GetGraphic(20, Color.Black, Color.White, (Bitmap)Bitmap.FromFile("C:\\myimage.png")); |
| 42 | +``` |
| 43 | + |
| 44 | +There are a plenty of other options. So feel free to read more on that in our wiki: [Wiki: How to use QRCoder](https://github.com/codebude/QRCoder/wiki/How-to-use-QRCoder) |
| 45 | + |
| 46 | +## Help & Issues |
| 47 | + |
| 48 | +If you think you have a bug or have new ideas/feature requests, then feel free to open a new issues: https://github.com/codebude/QRCoder/issues |
| 49 | +In case you have a question about using the library (and couldn't find an answer in our wiki), feel free to open a new question/discussion: https://github.com/codebude/QRCoder/discussions |
| 50 | + |
| 51 | + |
| 52 | +## Legal information and credits |
| 53 | + |
| 54 | +QRCoder is a project by [Raffael Herrmann](https://raffaelherrmann.de) and was first released in 10/2013. It's licensed under the [MIT license](https://github.com/codebude/QRCoder/blob/master/LICENSE.txt). |
0 commit comments