comparison vendor/endroid/qr-code/README.md @ 6:cec75ba50afc

endroid/qrcode as distributed
author Charlie Root
date Sat, 13 Jan 2018 09:00:52 -0500
parents
children
comparison
equal deleted inserted replaced
5:b31e49dc4392 6:cec75ba50afc
1 QR Code
2 =======
3
4 *By [endroid](http://endroid.nl/)*
5
6 [![Latest Stable Version](http://img.shields.io/packagist/v/endroid/qrcode.svg)](https://packagist.org/packages/endroid/qrcode)
7 [![Build Status](http://img.shields.io/travis/endroid/QrCode.svg)](http://travis-ci.org/endroid/QrCode)
8 [![Total Downloads](http://img.shields.io/packagist/dt/endroid/qrcode.svg)](https://packagist.org/packages/endroid/qrcode)
9 [![License](http://img.shields.io/packagist/l/endroid/qrcode.svg)](https://packagist.org/packages/endroid/qrcode)
10
11 This library based on QRcode Perl CGI & PHP scripts by Y. Swetake helps you generate images containing a QR code.
12
13 ## Installation
14
15 Use [Composer](https://getcomposer.org/) to install the library.
16
17 ``` bash
18 $ composer require endroid/qrcode
19 ```
20
21 ## Usage
22
23 ```php
24 <?php
25
26 use Endroid\QrCode\QrCode;
27
28 $qrCode = new QrCode();
29 $qrCode
30 ->setText("Life is too short to be generating QR codes")
31 ->setSize(300)
32 ->setPadding(10)
33 ->setErrorCorrection('high')
34 ->setForegroundColor(array('r' => 0, 'g' => 0, 'b' => 0, 'a' => 0))
35 ->setBackgroundColor(array('r' => 255, 'g' => 255, 'b' => 255, 'a' => 0))
36 ->setLabel('My label')
37 ->setLabelFontSize(16)
38 ->render()
39 ;
40 ```
41
42 ![QR Code](http://endroid.nl/qrcode/Life%20is%20too%20short%20to%20be%20generating%20QR%20codes.png)
43
44 ## Symfony
45
46 You can use [`EndroidQrCodeBundle`](https://github.com/endroid/EndroidQrCodeBundle) to integrate this service in your Symfony application.
47
48 ## Versioning
49
50 Version numbers follow the MAJOR.MINOR.PATCH scheme. Backwards compatible
51 changes will be kept to a minimum but be aware that these can occur. Lock
52 your dependencies for production and test your code when upgrading.
53
54 ## License
55
56 This bundle is under the MIT license. For the full copyright and license
57 information please view the LICENSE file that was distributed with this source code.