Mercurial > hg > rc1
diff 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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/vendor/endroid/qr-code/README.md Sat Jan 13 09:00:52 2018 -0500 @@ -0,0 +1,57 @@ +QR Code +======= + +*By [endroid](http://endroid.nl/)* + +[![Latest Stable Version](http://img.shields.io/packagist/v/endroid/qrcode.svg)](https://packagist.org/packages/endroid/qrcode) +[![Build Status](http://img.shields.io/travis/endroid/QrCode.svg)](http://travis-ci.org/endroid/QrCode) +[![Total Downloads](http://img.shields.io/packagist/dt/endroid/qrcode.svg)](https://packagist.org/packages/endroid/qrcode) +[![License](http://img.shields.io/packagist/l/endroid/qrcode.svg)](https://packagist.org/packages/endroid/qrcode) + +This library based on QRcode Perl CGI & PHP scripts by Y. Swetake helps you generate images containing a QR code. + +## Installation + +Use [Composer](https://getcomposer.org/) to install the library. + +``` bash +$ composer require endroid/qrcode +``` + +## Usage + +```php +<?php + +use Endroid\QrCode\QrCode; + +$qrCode = new QrCode(); +$qrCode + ->setText("Life is too short to be generating QR codes") + ->setSize(300) + ->setPadding(10) + ->setErrorCorrection('high') + ->setForegroundColor(array('r' => 0, 'g' => 0, 'b' => 0, 'a' => 0)) + ->setBackgroundColor(array('r' => 255, 'g' => 255, 'b' => 255, 'a' => 0)) + ->setLabel('My label') + ->setLabelFontSize(16) + ->render() +; +``` + +![QR Code](http://endroid.nl/qrcode/Life%20is%20too%20short%20to%20be%20generating%20QR%20codes.png) + +## Symfony + +You can use [`EndroidQrCodeBundle`](https://github.com/endroid/EndroidQrCodeBundle) to integrate this service in your Symfony application. + +## Versioning + +Version numbers follow the MAJOR.MINOR.PATCH scheme. Backwards compatible +changes will be kept to a minimum but be aware that these can occur. Lock +your dependencies for production and test your code when upgrading. + +## License + +This bundle is under the MIT license. For the full copyright and license +information please view the LICENSE file that was distributed with this source code.