Skip to content

Commit

Permalink
update readme and code style cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
Greaby committed Sep 3, 2023
1 parent 9d23e96 commit 2cffee0
Show file tree
Hide file tree
Showing 6 changed files with 120 additions and 119 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed
- fix penalty rule 3
- fix missing remainder Bits

### Changed
- update readme
- code style cleanup
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# QR code generator - Godot Engine
# QR code generator - Godot Engine 3.4+

<p>
<a href="https://github.com/Greaby/godot-qrcode-generator/issues">
Expand All @@ -18,13 +18,13 @@ This generator creates textures of a QR code from a string.
## How to use

Create a new QR code instance and pass it your text.
The class returns an ImageTexture that you can add in an Image
The class returns an `ImageTexture` that you can add in an Image

```gdscript
var qr_code: QrCode = QrCode.new()
# choose the level of error correction (LOW, MEDIUM, QUARTILE, HIGH)
qr_code.error_correct_level = QrCode.ERROR_CORRECT_LEVEL.LOW
qr_code.error_correct_level = QrCode.ErrorCorrectionLevel.LOW
var texture: ImageTexture = qr_code.get_texture("Godot") # Add your text here
Expand All @@ -36,8 +36,8 @@ qr_code_image.texture = texture

## Dependencies

This project require Godot Engine 3.4.
This project require Godot Engine 3.4+

## Licenses

- The source code is available under the MIT license.
- The source code is available under the MIT license.
Loading

0 comments on commit 2cffee0

Please sign in to comment.