Skip to content

Commit 0f186c6

Browse files
committed
📖
1 parent 30c2d46 commit 0f186c6

File tree

4 files changed

+38
-19
lines changed

4 files changed

+38
-19
lines changed

README.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,24 @@ It also features a QR Code reader based on a [PHP port](https://github.com/khana
1313
[![Packagist downloads][downloads-badge]][downloads]
1414
[![Documentation][readthedocs-badge]][readthedocs]
1515

16-
[php-badge]: https://img.shields.io/packagist/php-v/chillerlan/php-qrcode?logo=php&color=8892BF
16+
[php-badge]: https://img.shields.io/packagist/php-v/chillerlan/php-qrcode?logo=php&color=8892BF&logoColor=fff
1717
[php]: https://www.php.net/supported-versions.php
18-
[packagist-badge]: https://img.shields.io/packagist/v/chillerlan/php-qrcode.svg?logo=packagist
18+
[packagist-badge]: https://img.shields.io/packagist/v/chillerlan/php-qrcode.svg?logo=packagist&logoColor=fff
1919
[packagist]: https://packagist.org/packages/chillerlan/php-qrcode
20-
[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/php-qrcode/ci.yml?branch=v5.0.x&logo=github
20+
[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/php-qrcode/ci.yml?branch=v5.0.x&logo=github&logoColor=fff
2121
[gh-action]: https://github.com/chillerlan/php-qrcode/actions/workflows/ci.yml?query=branch%3Amain
22-
[coverage-badge]: https://img.shields.io/codecov/c/github/chillerlan/php-qrcode/v5.0.x?logo=codecov
22+
[coverage-badge]: https://img.shields.io/codecov/c/github/chillerlan/php-qrcode/v5.0.x?logo=codecov&logoColor=fff
2323
[coverage]: https://app.codecov.io/gh/chillerlan/php-qrcode/tree/v5.0.x
24-
[codacy-badge]: https://img.shields.io/codacy/grade/edccfc4fe5a34b74b1c53ee03f097b8d/v5.0.x?logo=codacy
24+
[codacy-badge]: https://img.shields.io/codacy/grade/edccfc4fe5a34b74b1c53ee03f097b8d/v5.0.x?logo=codacy&logoColor=fff
2525
[codacy]: https://app.codacy.com/gh/chillerlan/php-qrcode/dashboard?branch=v5.0.x
26-
[downloads-badge]: https://img.shields.io/packagist/dt/chillerlan/php-qrcode?logo=packagist
26+
[downloads-badge]: https://img.shields.io/packagist/dt/chillerlan/php-qrcode?logo=packagist&logoColor=fff
2727
[downloads]: https://packagist.org/packages/chillerlan/php-qrcode/stats
28-
[readthedocs-badge]: https://img.shields.io/readthedocs/php-qrcode/v5.0.x?logo=readthedocs
28+
[readthedocs-badge]: https://img.shields.io/readthedocs/php-qrcode/v5.0.x?logo=readthedocs&logoColor=fff
2929
[readthedocs]: https://php-qrcode.readthedocs.io/en/v5.0.x/
3030

31-
## Overview
31+
# Overview
3232

33-
### Features
33+
## Features
3434

3535
- Creation of [Model 2 QR Codes](https://www.qrcode.com/en/codes/model12.html), [Version 1 to 40](https://www.qrcode.com/en/about/version.html)
3636
- [ECC Levels](https://www.qrcode.com/en/about/error_correction.html) L/M/Q/H supported
@@ -52,7 +52,7 @@ It also features a QR Code reader based on a [PHP port](https://github.com/khana
5252
- QR Code reader (via GD and ImageMagick)
5353

5454

55-
### Requirements
55+
## Requirements
5656

5757
- PHP 7.4+
5858
- [`ext-mbstring`](https://www.php.net/manual/book.mbstring.php)
@@ -65,12 +65,17 @@ It also features a QR Code reader based on a [PHP port](https://github.com/khana
6565
For the QRCode reader, either `ext-gd` or `ext-imagick` is required!
6666

6767

68-
## Documentation
68+
# Documentation
6969

7070
- The user manual is at https://php-qrcode.readthedocs.io/ ([sources](https://github.com/chillerlan/php-qrcode/tree/v5.0.x/docs))
7171
- An API documentation created with [phpDocumentor](https://www.phpdoc.org/) can be found at https://chillerlan.github.io/php-qrcode/
7272
- The documentation for the `QROptions` container can be found here: [chillerlan/php-settings-container](https://github.com/chillerlan/php-settings-container#readme)
7373

74+
**Important: Please use the examples from the branch that matches your installed php-qrcode version (
75+
[v4.x](https://github.com/chillerlan/php-qrcode/tree/v4.3.x/examples),
76+
[v5.x](https://github.com/chillerlan/php-qrcode/tree/v5.0.x/examples),
77+
[dev-main](https://github.com/chillerlan/php-qrcode/tree/main/examples)
78+
)!**
7479

7580
## Installation with [composer](https://getcomposer.org)
7681

@@ -117,7 +122,7 @@ Also, have a look [in the examples folder](https://github.com/chillerlan/php-qrc
117122
</p>
118123

119124

120-
### Reading QR Codes
125+
## Reading QR Codes
121126

122127
Using the built-in QR Code reader is pretty straight-forward:
123128

@@ -139,30 +144,30 @@ catch(Throwable $e){
139144
```
140145

141146

142-
## Shameless advertising
147+
# Shameless advertising
143148

144149
Hi, please check out some of my other projects that are way cooler than qrcodes!
145150

146151
- [js-qrcode](https://github.com/chillerlan/js-qrcode) - a javascript port of this library
147152
- [php-authenticator](https://github.com/chillerlan/php-authenticator) - a Google Authenticator implementation (see [authenticator example](https://github.com/chillerlan/php-qrcode/blob/v5.0.x/examples/authenticator.php))
148153
- [php-httpinterface](https://github.com/chillerlan/php-httpinterface) - a PSR-7/15/17/18 implemetation
149-
- [php-oauth-core](https://github.com/chillerlan/php-oauth-core) - an OAuth 1/2 client library along with a bunch of [providers](https://github.com/chillerlan/php-oauth-providers)
154+
- [php-oauth](https://github.com/chillerlan/php-oauth) - an OAuth 1/2 client library, fully PSR-7/PSR-17/PSR-18 compatible
150155
- [php-database](https://github.com/chillerlan/php-database) - a database client & querybuilder for MySQL, Postgres, SQLite, MSSQL, Firebird
151156
- [php-tootbot](https://github.com/php-tootbot/tootbot-template) - a Mastodon bot library (see [@dwil](https://github.com/php-tootbot/dwil))
152157

153158

154-
## Disclaimer!
159+
# Disclaimer!
155160

156161
I don't take responsibility for molten CPUs, misled applications, failed log-ins etc.. Use at your own risk!
157162

158163

159-
### License notice
164+
## License notice
160165

161166
- Parts of this code are [ported to PHP](https://github.com/codemasher/php-qrcode-decoder) from the [ZXing project](https://github.com/zxing/zxing) and licensed under the [Apache License, Version 2.0](./NOTICE).
162167
- [The documentation](https://github.com/chillerlan/php-qrcode/tree/v5.0.x/docs) is licensed under the [Creative Commons Attribution 4.0 International (CC BY 4.0) License](https://creativecommons.org/licenses/by/4.0/).
163168

164169

165-
### Trademark Notice
170+
## Trademark Notice
166171

167172
The word "QR Code" is a registered trademark of *DENSO WAVE INCORPORATED*<br>
168173
https://www.qrcode.com/en/faq.html#patentH2Title

docs/Appendix/URI-Content.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ A phone number should be prefixed with the `tel:` scheme so that a device's dial
6464
tel:+999-123-456-7890
6565
```
6666

67-
Generally, the most complete version of a telephone number possible sould be used, e.g. `+<country code><area code><number>`, spaces or hyphens may be used to separate blocks.
67+
Generally, the most complete version of a telephone number possible should be used, e.g. `+<country code><area code><number>`, spaces or hyphens may be used to separate blocks.
6868
Some devices may also support the `sms` and `fax` schemes, which are deprecated in favor of `tel`.
6969

7070
**See also:**
@@ -251,6 +251,12 @@ END:VCALENDAR
251251
- [iCalendar generator for PHP (GitHub)](https://github.com/spatie/icalendar-generator)
252252

253253

254+
## SEPA Credit Transfer
255+
256+
- [Guidelines to Enable the Data Capture for the Initiation of a SEPA Credit Transfer](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/quick-response-code-guidelines-enable-data-capture-initiation)
257+
- [sepa-qr-data library for PHP (GitHub)](https://github.com/smhg/sepa-qr-data-php)
258+
259+
254260
## See also
255261

256262
- [RFC 3986 - Uniform Resource Identifier (URI): Generic Syntax](https://datatracker.ietf.org/doc/html/rfc3986)

docs/Built-In-Output/QRImagick.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Please follow the installation guides for your operating system:
1414
See: [ImageMagick example](https://github.com/chillerlan/php-qrcode/blob/v5.0.x/examples/imagick.php)
1515

1616
Set the options:
17+
1718
```php
1819
$options = new QROptions;
1920

docs/Usage/Overview.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ For the QR Code reader, either `ext-gd` or `ext-imagick` is required!
4141

4242
## Framework Integration
4343

44+
- CakePHP:
45+
- [QrCode plugin](https://github.com/dereuromark/cakephp-qrcode)
4446
- Drupal:
4547
- [Two-factor Authentication `tfa`](https://www.drupal.org/project/tfa) (Drupal 8+)
4648
- [Google Authenticator Login `ga_login`](https://www.drupal.org/project/ga_login) (deprecated, Drupal 7)
@@ -62,6 +64,11 @@ For the QR Code reader, either `ext-gd` or `ext-imagick` is required!
6264
- [Elefant CMS](https://github.com/jbroadway/elefant)
6365
- [OSIRIS](https://github.com/JKoblitz/osiris)
6466
- [EspoCRM](https://github.com/espocrm/espocrm)
67+
- [FusionCMS](https://github.com/FusionWowCMS/FusionCMS)
68+
- [HortusFox](https://github.com/danielbrendel/hortusfox-web)
69+
- [Pelican Panel](https://github.com/pelican-dev/panel)
70+
- [Laravel Boleto](https://github.com/eduardokum/laravel-boleto)
71+
- [OpenBoleto](https://github.com/openboleto/openboleto)
6572
- Articles:
6673
- [Twilio: How to Create a QR Code in PHP](https://www.twilio.com/blog/create-qr-code-in-php) (featuring v4.3.x)
6774

@@ -73,6 +80,6 @@ Hi, please check out some of my other projects that are way cooler than qrcodes!
7380
- [js-qrcode](https://github.com/chillerlan/js-qrcode) - a javascript port of this library
7481
- [php-authenticator](https://github.com/chillerlan/php-authenticator) - a Google Authenticator implementation (see [authenticator example](https://github.com/chillerlan/php-qrcode/blob/v5.0.x/examples/authenticator.php))
7582
- [php-httpinterface](https://github.com/chillerlan/php-httpinterface) - a PSR-7/15/17/18 implemetation
76-
- [php-oauth-core](https://github.com/chillerlan/php-oauth-core) - an OAuth 1/2 client library along with a bunch of [providers](https://github.com/chillerlan/php-oauth-providers)
83+
- [php-oauth](https://github.com/chillerlan/php-oauth) - an OAuth 1/2 client library, fully PSR-7/PSR-17/PSR-18 compatible
7784
- [php-database](https://github.com/chillerlan/php-database) - a database client & querybuilder for MySQL, Postgres, SQLite, MSSQL, Firebird
7885
- [php-tootbot](https://github.com/php-tootbot/tootbot-template) - a Mastodon bot library

0 commit comments

Comments
 (0)