Better README

README.md

@@ -3,49 +3,82 @@
 [![Latest Stable Version](https://poser.pugx.org/dfridrich/qr-platba/v/stable)](https://packagist.org/packages/dfridrich/qr-platba)
 [![Total Downloads](https://poser.pugx.org/dfridrich/qr-platba/downloads)](https://packagist.org/packages/dfridrich/qr-platba)
 [![Build Status](https://travis-ci.org/dfridrich/QRPlatba.svg)](https://travis-ci.org/dfridrich/QRPlatba)
-[![Coverage Status](https://coveralls.io/repos/dfridrich/QRPlatba/badge.svg?branch=master&service=github)](https://coveralls.io/github/dfridrich/QRPlatba?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/dfridrich/QRPlatba/badge.svg?branch=master)](https://coveralls.io/github/dfridrich/QRPlatba?branch=master)
 
-Knihovna pro generování QR plateb v PHP.
+Knihovna pro generování QR plateb v PHP. QR platba zjednodušuje koncovému uživateli
+provedení příkazu k úhradě, protože obsahuje veškeré potřebné údaje, které stačí jen
+naskenovat. Nově lze použít i jiné měny než CZK a to pomocí metody ```setCurrenty($currency)```.
+
+Tato knihovna umožňuje:
+
+- zobrazení obrázku v ```<img>``` tagu, který obsahuje v ```src``` rovnou data-uri s QR kódem, takže vygenerovaný
+obrázek tak není třeba ukládat na server (```$qrPlatba->getQRCodeImage()```)
+- uložení obrázku s QR kódem (```$qrPlatba->saveQRCodeImage()```)
+- získání data-uri (```$qrPlatba->getQRCodeInstance()->getDataUri()```)
+- získání instance objektu [QrCode](https://github.com/endroid/QrCode) (```$qrPlatba->getQRCodeInstance()```) 
+
+QRPlatbu v současné době podporují tyto banky:
+Air Bank, Česká spořitelna, ČSOB, Equa bank, Era, Fio banka, Komerční banka, mBank, Raiffeisenbank, ZUNO.
 
-## Instalace pomocí Composeru
 
-`composer require dfridrich/qr-platba:~1.0`
+Podporuje PHP 5.4 až 7.2.
 
-## Dokumentace
+## Instalace pomocí Composeru
 
-Dokumentaci najdete na adrese http://dfridrich.github.io/QRPlatba/
+`composer require dfridrich/qr-platba`
 
 ## Příklad
 
 ```php
 <?php
 
-require "vendor/autoload.php";
+require __DIR__ . '/vendor/autoload.php';
 
 use Defr\QRPlatba\QRPlatba;
 
 $qrPlatba = new QRPlatba();
 
-$qrPlatba->setAccount("12-3456789012/0100")
-    ->setVariableSymbol("2016001234")
-    ->setMessage("Toto je první QR platba.")
-    ->setSpecificSymbol("0308")
-    ->setSpecificSymbol("1234")
-    ->setCurrency("CZK") // Výchozí je CZK, lze zadat jakýkoli ISO kód měny
+$qrPlatba->setAccount('12-3456789012/0100')
+    ->setVariableSymbol('2016001234')
+    ->setMessage('Toto je první QR platba.')
+    ->setSpecificSymbol('0308')
+    ->setSpecificSymbol('1234')
+    ->setCurrency('CZK') // Výchozí je CZK, lze zadat jakýkoli ISO kód měny
     ->setDueDate(new \DateTime());
 
-echo $qrPlatba->getQRCodeImage();
+echo $qrPlatba->getQRCodeImage(); // Zobrazí <img> tag s kódem, viz níže  
+```
+
+![Ukázka](qrcode.png)
 
-// nebo...
+Lze použít i jednodušší zápis:
 
-echo QRPlatba::create("12-3456789012/0100", 987.60)->setMessage("QR platba je parádní!")->getQRCodeImage();
+```php
+echo QRPlatba::create('12-3456789012/0100', 987.60)
+    ->setMessage('QR platba je parádní!')
+    ->getQRCodeImage();
+```
+
+### Další možnosti
+
+Uložení do souboru
+```php
+// Uloží jpg o velikosti 100x100 px a paddingem 0 px
+$qrPlatba->saveQRCodeImage("qrcode.jpg", "jpg", 100, 0);
+```
+
+Zobrazení data-uri
+```php
+// data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUAAAAFAAQMAAAD3XjfpAAAA...
+echo $qrPlatba->getQRCodeInstance()->getDataUri();
 ```
 
 ## Odkazy
 
+- Dokumentace - http://dfridrich.github.io/QRPlatba/
 - Oficiálí web QR Platby - http://qr-platba.cz/
 - Repozitář, který mě inspiroval - https://github.com/snoblucha/QRPlatba
 
 ## Contributing
 
-Budu rád za každý návrh na vylepšení :-)
+Budu rád za každý návrh na vylepšení ať už formou issue nebo pull requestu.