Skip to content

Commit 763bca7

Browse files
author
Martin Brecht-Precht
committed
Updated readme.
1 parent 0386867 commit 763bca7

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# QR Code Suite
22

33
[![Code Climate](https://codeclimate.com/github/markenwerk/php-qr-code-suite/badges/gpa.svg)](https://codeclimate.com/github/markenwerk/php-qr-code-suite)
4-
[![Issue Count](https://codeclimate.com/github/markenwerk/php-qr-code-suite/badges/issue_count.svg)](https://codeclimate.com/github/markenwerk/php-qr-code-suite)
54
[![Latest Stable Version](https://poser.pugx.org/markenwerk/qr-code-suite/v/stable)](https://packagist.org/packages/markenwerk/qr-code-suite)
65
[![Total Downloads](https://poser.pugx.org/markenwerk/qr-code-suite/downloads)](https://packagist.org/packages/markenwerk/qr-code-suite)
76
[![License](https://poser.pugx.org/markenwerk/qr-code-suite/license)](https://packagist.org/packages/markenwerk/qr-code-suite)
@@ -24,13 +23,38 @@ A collection of classes to QR enccode strings and render them as PNG, TIFF and v
2423

2524
```{php}
2625
require_once('path/to/vendor/autoload.php');
27-
28-
use QrCodeSuite;
2926
```
3027

3128
### Encoding data as QR code block data
3229

30+
```{php}
31+
use QrCodeSuite\QrEncode\QrEncoder;
32+
33+
// Encode the data as QR code block data
34+
$encoder = new QrEncoder();
35+
$qrCodeData = $encoder
36+
->setLevel(QrEncoder::QR_CODE_LEVEL_LOW)
37+
->setTempDir('path/to/writable/directory')
38+
->encodeQrCode('https://github.com/markenwerk/php-qr-code-suite');
39+
```
40+
41+
### Render encoded QR code block data as image
3342

43+
```{php}
44+
use QrCodeSuite\QrRender;
45+
46+
// Render the encoded QR code block data as RGB PNG
47+
$renderer = new QrRender\QrCodeRendererPng();
48+
$renderer->render($qrCodeData, 'path/to/qr-code.png');
49+
50+
// Render the encoded QR code block data as CMYK TIFF
51+
$renderer = new QrRender\QrCodeRendererTiff();
52+
$renderer->render($qrCodeData, 'path/to/qr-code.tif');
53+
54+
// Render the encoded QR code block data as CMYK vectorized EPS
55+
$renderer = new QrRender\QrCodeRendererEps();
56+
$renderer->render($qrCodeData, 'path/to/qr-code.eps');
57+
```
3458

3559
---
3660

0 commit comments

Comments
 (0)