Skip to content

Commit

Permalink
chore(version): 3.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
aruZeta committed Jan 29, 2024
1 parent 8cd8f82 commit 08c20b4
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion QRgen.nimble
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Package

version = "3.0.0"
version = "3.1.0"
author = "aruZeta"
description = "A QR code generation library."
license = "MIT"
Expand Down
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/logo.svg"
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/logo.svg"
width="300px" height="300px" />
</p>

Expand Down Expand Up @@ -46,7 +46,7 @@ myQR.printTerminal
```

<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/terminal-example.png" width="200px" height="200px"/>
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/terminal-example.png" width="200px" height="200px"/>
</p>

---
Expand All @@ -60,7 +60,7 @@ myQR.printSvg
```

<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/svg-example.svg" width="200px" height="200px" />
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/svg-example.svg" width="200px" height="200px" />
</p>

---
Expand All @@ -72,7 +72,7 @@ myQR.printSvg("#1d2021","#98971a")
```

<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/svg-colors-example.svg" width="200px" height="200px" />
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/svg-colors-example.svg" width="200px" height="200px" />
</p>

`"#1d2021"` sets the "light" or "background" color.
Expand All @@ -87,7 +87,7 @@ myQR.printSvg("#1d2021","#98971a",60)
```

<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/svg-rounded-example.svg" width="200px" height="200px"/>
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/svg-rounded-example.svg" width="200px" height="200px"/>
</p>

`60` sets the alignment patterns' roundness to 60%.
Expand All @@ -101,7 +101,7 @@ myQR.printSvg("#1d2021","#98971a",100,100)
```

<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/svg-very-rounded-example.svg" width="200px" height="200px" />
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/svg-very-rounded-example.svg" width="200px" height="200px" />
</p>

The first `100` sets the alignment patterns' roundness to 100%
Expand All @@ -116,7 +116,7 @@ myQR.printSvg("#1d2021","#98971a",100,100,25)
```

<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/svg-separation-example.svg" width="200px" height="200px" />
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/svg-separation-example.svg" width="200px" height="200px" />
</p>

The last `25` sets the module's separation to 25%.
Expand All @@ -136,7 +136,7 @@ myQR.printSvg("#1d2021","#98971a",100,100,25,svgImg=readFile("QRgen-logo.svg"))
```

<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/svg-embed-example.svg" width="200px" height="200px" />
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/svg-embed-example.svg" width="200px" height="200px" />
</p>

`svgImg` adds an SVG image embed in the center of generated
Expand Down Expand Up @@ -185,7 +185,7 @@ myQR.renderImg
```

<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/png-example.png" width="200px" height="200px" />
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/png-example.png" width="200px" height="200px" />
</p>

---
Expand All @@ -197,7 +197,7 @@ myQR.renderImg("#1d2021","#98971a")
```

<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/png-colors-example.png" width="200px" height="200px" />
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/png-colors-example.png" width="200px" height="200px" />
</p>

`"#1d2021"` sets the "light" or "background" color.
Expand All @@ -212,7 +212,7 @@ myQR.renderImg("#1d2021","#98971a",60)
```

<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/png-rounded-example.png" width="200px" height="200px"/>
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/png-rounded-example.png" width="200px" height="200px"/>
</p>

`60` sets the alignment patterns' roundness to 60%.
Expand All @@ -226,7 +226,7 @@ myQR.renderImg("#1d2021","#98971a",100,100)
```

<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/png-very-rounded-example.png" width="200px" height="200px" />
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/png-very-rounded-example.png" width="200px" height="200px" />
</p>

The first `100` sets the alignment patterns' roundness to 100%
Expand All @@ -241,7 +241,7 @@ myQR.renderImg("#1d2021","#98971a",100,100,25)
```

<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/png-separation-example.png" width="200px" height="200px" />
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/png-separation-example.png" width="200px" height="200px" />
</p>

The last `25` sets the module's separation to 25%.
Expand All @@ -261,7 +261,7 @@ myQR.renderImg("#1d2021","#98971a",100,100,25,img=readImage("QRgen-logo.png"))
```

<p align="center">
<img src="https://github.com/aruZeta/QRgen/blob/develop/share/img/png-embed-example.png" width="200px" height="200px" />
<img src="https://github.com/aruZeta/QRgen/blob/main/share/img/png-embed-example.png" width="200px" height="200px" />
</p>

`img` embeds an `Image` in the center of the generated QR code,
Expand All @@ -278,17 +278,17 @@ Note that you can change the resolution of the generated image by setting

## Documentation

Check the [docs](https://aruzeta.github.io/QRgen/develop/QRgen.html) to
Check the [docs](https://aruzeta.github.io/QRgen/main/QRgen.html) to
know more about the main API.

## More examples

Check my simple terminal app's code, [QRterm](https://github.com/aruZeta/QRterm),
which uses this library to generate QR codes from your terminal, and also it's
[logo generator](https://github.com/aruZeta/QRterm/blob/develop/src/generateLogo.nim).
[logo generator](https://github.com/aruZeta/QRterm/blob/main/src/generateLogo.nim).

Also check
[this repo's logo and its README images generator](https://github.com/aruZeta/QRgen/blob/develop/src/generateRepoImages.nim).
[this repo's logo and its README images generator](https://github.com/aruZeta/QRgen/blob/main/src/generateRepoImages.nim).

## License

Expand Down

0 comments on commit 08c20b4

Please sign in to comment.