Skip to content

Commit aaae56b

Browse files
committed
Updated and simplified readme.md
- Updated/fixed the link on how to setup Github Nuget package repository - Simplified example code as details are also explained in the Wiki and the readme should be as clean/simple as possible
1 parent 8e226f2 commit aaae56b

File tree

1 file changed

+3
-21
lines changed

1 file changed

+3
-21
lines changed

readme.md

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ PM> Install-Package QRCoder
3535

3636
#### CI builds
3737
The NuGet feed contains only **major/stable** releases. If you want the latest functions and features, you can use the CI builds [via Github packages](https://github.com/codebude/qrcoder/packages).
38-
_(More information on how to use Github Packages in Nuget Package Manager can be [found here](http://webcache.googleusercontent.com/search?q=cache:i_gL6oIwpr8J:www.catiawidgets.net/2021/04/20/creating-github-packages-and-accessing-them-in-nuget/+&cd=1&hl=de&ct=clnk&gl=de).)_
38+
_(More information on how to use Github Packages in Nuget Package Manager can be [found here](https://samlearnsazure.blog/2021/08/08/consuming-a-nuget-package-from-github-packages/).)_
3939

4040

4141
## Usage
4242

43-
You only need four lines of code, to generate and view your first QR code.
43+
You only need a couple lines of code, to generate your first QR code.
4444

4545
```csharp
4646
QRCodeGenerator qrGenerator = new QRCodeGenerator();
@@ -49,29 +49,11 @@ QRCode qrCode = new PngByteQRCode(qrCodeData);
4949
byte[] qrCodeImage = qrCode.GetGraphic(20);
5050
```
5151

52-
### Optional parameters and overloads
53-
54-
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.
55-
56-
```csharp
57-
//Set color by using Color-class types
58-
Bitmap qrCodeImage = qrCode.GetGraphic(20, Color.DarkRed, Color.PaleGreen, true);
59-
60-
//Set color by using HTML hex color notation
61-
Bitmap qrCodeImage = qrCode.GetGraphic(20, "#000ff0", "#0ff000");
62-
```
63-
64-
The other overload enables you to render a logo/image in the center of the QR code.
65-
66-
```csharp
67-
Bitmap qrCodeImage = qrCode.GetGraphic(20, Color.Black, Color.White, (Bitmap)Bitmap.FromFile("C:\\myimage.png"));
68-
```
69-
7052
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)
7153

7254
### Special rendering types
7355

74-
Besides the normal QRCode class (which is shown in the example above) for creating QR codes in Bitmap format, there are some more QR code rendering classes, each for another special purpose.
56+
Besides the normal PngByteQRCode-class (which is shown in the example above) for creating QR codes in Bitmap format, there are some more QR code rendering classes, each for another special purpose.
7557

7658
* [QRCode](https://github.com/codebude/QRCoder/wiki/Advanced-usage---QR-Code-renderers#21-qrcode-renderer-in-detail)
7759
* [ArtQRCode](https://github.com/codebude/QRCoder/wiki/Advanced-usage---QR-Code-renderers#211-artqrcode-renderer-in-detail)

0 commit comments

Comments
 (0)