Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gcoro committed Aug 12, 2021
1 parent 146350e commit 5886b8f
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 10 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## [v2.5.0]
### Features
- Added new optional prop `eyeRadius` to specify the corner radius for the positional patterns.

## [v2.2.1]
### Fixes
- Changed `quietZone` implementation so that it's included directly in the canvas, instead of just an HTML padding. This fixes the issue that caused the QR Code to appear without the quiet zone when it got saved.
Expand Down
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Typescript React component to generate a customizable QR Code.
<div style="display: flex; flex-direction: row;">
<img src="res/qrcode-react.png" height="256" width="256">
<img src="res/qrcode-miku.png" height="256" width="256">
<img src="res/qrcode-android.png" height="256" width="256">
<img src="res/qrcode-ts.png" height="256" width="256">
</div>

## Installation
Expand Down Expand Up @@ -39,12 +39,9 @@ React.render(
| `logoHeight` | `number` (in pixels) | `logoWidth` | Logo image height |
| `logoOpacity` | `number` (css opacity 0 <= x <= 1) | `1` | Logo opacity. This allows you to modify the transparency of your logo, so that it won't compromise the readability of the QR Code |
| `qrStyle` | `squares` &#124; `dots` | `squares` | Style of the QR Code modules |
| `eyeRadius` | `number | number[] | number[][]` | The corner radius for the positional patterns (the three "eyes" around the QR code). See more details below |
| `eyeRadius` | `number` &#124; `number[]` &#124; `number[][]` | | The corner radius for the positional patterns (the three "eyes" around the QR code). See more details below |

## Example
You can find a very simple demo project [here](https://github.com/gcoro/QRCodeCustomizer).

## Positional Pattern Radius
### About eyeRadius

Give the positional pattern custom radii. You can either set one radius for all corners or all positional eyes, or
specify a radius for each corner of each eye.
Expand Down Expand Up @@ -89,6 +86,9 @@ eyeRadius={[
]}
```

## Usage example
You can find a very simple demo project [here](https://github.com/gcoro/QRCodeCustomizer).

## Contributing
Thanks to everyone who contributed :) PRs and suggestions are welcome.

Expand All @@ -98,18 +98,22 @@ Thanks to everyone who contributed :) PRs and suggestions are welcome.
<img src="https://avatars.githubusercontent.com/u/37499369?v=4" width="100px;" alt="gcoro" /><br />
<sup><b>gcoro</b></sup></a><br />
</td><td align="center" valign="top">
<a href="https://github.com/jgillick">
<img src="https://avatars.githubusercontent.com/u/35894?v=4" width="100px;" alt="jgillick" /><br />
<sup><b>jgillick</b></sup></a><br />
</td><td align="center" valign="top">
<a href="https://github.com/JChord">
<img src="https://avatars.githubusercontent.com/u/981214?v=4" width="100px;" alt="JChord" /><br />
<sup><b>JChord</b></sup></a><br />
</td><td align="center" valign="top">
<a href="https://github.com/mushang11">
<img src="https://avatars.githubusercontent.com/u/13930277?v=4" width="100px;" alt="mushang11" /><br />
<sup><b>mushang11</b></sup></a><br />
</td><td align="center" valign="top">
<a href="https://github.com/halitogunc">
<img src="https://avatars.githubusercontent.com/u/13641726?v=4" width="100px;" alt="halitogunc" /><br />
<sup><b>halitogunc</b></sup></a><br />
</td><td align="center" valign="top">
<a href="https://github.com/mushang11">
<img src="https://avatars.githubusercontent.com/u/13930277?v=4" width="100px;" alt="mushang11" /><br />
<sup><b>mushang11</b></sup></a><br />
</td><td align="center" valign="top">
<a href="https://github.com/Trexy94">
<img src="https://avatars.githubusercontent.com/u/16225761?v=4" width="100px;" alt="Trexy94" /><br />
<sup><b>Trexy94</b></sup></a><br />
Expand Down
Binary file added res/qrcode-ts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5886b8f

Please sign in to comment.