Merge pull request #522 from codebude/fix-readmes-and-update-codecov

Fix readmes and update codecov
codebude · May 13, 2024 · 6718e5b · 6718e5b
2 parents 6d41db5 + 42b3ac9
commit 6718e5b
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 18 deletions.
diff --git a/.github/workflows/wf-build-release-ci.yml b/.github/workflows/wf-build-release-ci.yml
@@ -92,35 +92,35 @@ jobs:
       run: dotnet test -c Release --nologo --no-build
 
     - name: Codecov update netcoreapp2.0
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./QRCoderTests/coverage.netcoreapp2.0.opencover.xml
         flags: netcoreapp2.0
 
     - name: Codecov update net5.0
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./QRCoderTests/coverage.net5.0.opencover.xml
         flags: net5.0
 
     - name: Codecov update net5.0-windows
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./QRCoderTests/coverage.net5.0-windows.opencover.xml
         flags: net5.0-windows
 
     - name: Codecov update net6.0
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./QRCoderTests/coverage.net5.0.opencover.xml
         flags: net6.0
 
     - name: Codecov update net6.0-windows
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./QRCoderTests/coverage.net5.0-windows.opencover.xml

diff --git a/.github/workflows/wf-build-release.yml b/.github/workflows/wf-build-release.yml
@@ -93,35 +93,35 @@ jobs:
       run: dotnet test -c Release --nologo --no-build
 
     - name: Codecov update netcoreapp2.0
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./QRCoderTests/coverage.netcoreapp2.0.opencover.xml
         flags: netcoreapp2.0
 
     - name: Codecov update net5.0
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./QRCoderTests/coverage.net5.0.opencover.xml
         flags: net5.0
 
     - name: Codecov update net5.0-windows
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./QRCoderTests/coverage.net5.0-windows.opencover.xml
         flags: net5.0-windows
 
     - name: Codecov update net6.0
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./QRCoderTests/coverage.net5.0.opencover.xml
         flags: net6.0
 
     - name: Codecov update net6.0-windows
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./QRCoderTests/coverage.net5.0-windows.opencover.xml

diff --git a/QRCoder/Assets/nuget-readme.md b/QRCoder/Assets/nuget-readme.md
@@ -19,10 +19,12 @@ The release notes for the current and all past releases can be read here: [📄
 You only need a couple lines of code, to generate your first QR code.
 
 ```csharp
-QRCodeGenerator qrGenerator = new QRCodeGenerator();
-QRCodeData qrCodeData = qrGenerator.CreateQrCode("The text which should be encoded.", QRCodeGenerator.ECCLevel.Q);
-QRCode qrCode = new PngByteQRCode(qrCodeData);
-byte[] qrCodeImage = qrCode.GetGraphic(20);
+using (QRCodeGenerator qrGenerator = new QRCodeGenerator())
+using (QRCodeData qrCodeData = qrGenerator.CreateQrCode("The text which should be encoded.", QRCodeGenerator.ECCLevel.Q))
+using (PngByteQRCode qrCode = new PngByteQRCode(qrCodeData))
+{
+    byte[] qrCodeImage = qrCode.GetGraphic(20);
+}
 ```
 
 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)

diff --git a/readme.md b/readme.md
@@ -43,10 +43,12 @@ _(More information on how to use Github Packages in Nuget Package Manager can be
 You only need a couple lines of code, to generate your first QR code.
 
 ```csharp
-QRCodeGenerator qrGenerator = new QRCodeGenerator();
-QRCodeData qrCodeData = qrGenerator.CreateQrCode("The text which should be encoded.", QRCodeGenerator.ECCLevel.Q);
-QRCode qrCode = new PngByteQRCode(qrCodeData);
-byte[] qrCodeImage = qrCode.GetGraphic(20);
+using (QRCodeGenerator qrGenerator = new QRCodeGenerator())
+using (QRCodeData qrCodeData = qrGenerator.CreateQrCode("The text which should be encoded.", QRCodeGenerator.ECCLevel.Q))
+using (PngByteQRCode qrCode = new PngByteQRCode(qrCodeData))
+{
+    byte[] qrCodeImage = qrCode.GetGraphic(20);
+}
 ```
 
 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)