Update README.md

umbrellaTech · Sep 1, 2014 · 8b3a6be · 8b3a6be
1 parent bd4181f
commit 8b3a6be
Showing 1 changed file with 42 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,8 @@ ya-retorno-boleto
 [![Build Status](https://travis-ci.org/umbrellaTech/ya-retorno-boleto.svg?branch=master)](https://travis-ci.org/umbrellaTech/ya-retorno-boleto)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/umbrellaTech/ya-retorno-boleto/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/umbrellaTech/ya-retorno-boleto/?branch=master)
 [![Code Coverage](https://scrutinizer-ci.com/g/umbrellaTech/ya-retorno-boleto/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/umbrellaTech/ya-retorno-boleto/?branch=master)
+[![Latest Stable Version](https://poser.pugx.org/umbrella/retorno-boleto/v/stable.png)](https://packagist.org/packages/umbrella/retorno-boleto)
+[![Latest Unstable Version](https://poser.pugx.org/umbrella/retorno-boleto/v/unstable.png)](https://packagist.org/packages/umbrella/retorno-boleto)
 
 [![SensioLabsInsight](https://insight.sensiolabs.com/projects/1f67b9bd-f120-43d5-9f02-f73aa6132d86/small.png)](https://insight.sensiolabs.com/projects/1f67b9bd-f120-43d5-9f02-f73aa6132d86)
 
@@ -20,15 +22,15 @@ Arquivos suportados:
 | **Caixa Economica** | 150, 240                 | Sim                | Sim           |
 | **HSBC**            | 150, 240,400             | Sim                | Sim           |
 | **Itau**            | 150, 240,400             | Sim                | Sim           |
-| **Santander**       | 150, 240,400             | Sim                | Sim           |-
+| **Santander**       | 150, 240,400             | Sim                | Sim           |
 
 Instalação
 ----------
 
 ```shell
-  require: { "umbrella/retorno-boleto": "~1.2" }
+require: { "umbrella/retorno-boleto": "~1.2" }
 
-  $ composer install
+$ composer install
 ``` 
 
 Uso
@@ -37,16 +39,47 @@ Uso
 Para lermos um arquivo de retorno, utilizamos uma factory que nos dirao tipo correto do arquivo e passaremos ele para um processador que irá lhe retornar o objeto do arquivo de retorno.
 
 ```php
-  // Utilizamos a factory para construir o objeto correto para um determinado arquivo de retorno
-  $cnab = ProcessFactory::getRetorno('arquivo-retorno.ret');
+use Umbrella\Ya\RetornoBoleto\ProcessFactory;
+use Umbrella\Ya\RetornoBoleto\ProcessHandler;
 
-  // Passamos o objeto contruido para o handler
-  $processor = new ProcessHandler($cnab);
+// Utilizamos a factory para construir o objeto correto para um determinado arquivo de retorno
+$cnab = ProcessFactory::getRetorno('arquivo-retorno.ret');
+
+// Passamos o objeto contruido para o handler
+$processor = new ProcessHandler($cnab);
 
-  // Processamos o arquivo. Isso retornará um objeto parseado com todas as propriedades do arquvio.
-  $retorno = $processor->processar();
+// Processamos o arquivo. Isso retornará um objeto parseado com todas as propriedades do arquvio.
+$retorno = $processor->processar();
+```
+
+Eventos
+----------
+
+O retorno-boleto tem suporte a eventos utilizando o componente [EventDispatcher](http://symfony.com/doc/current/components/event_dispatcher/introduction.html) do symfony.
+
+```php
+use Umbrella\Ya\RetornoBoleto\Event\OnDetailRegisterEvent;
+use Umbrella\Ya\RetornoBoleto\ProcessFactory;
+use Umbrella\Ya\RetornoBoleto\ProcessHandler;
+use Umbrella\Ya\RetornoBoleto\RetornoEvents;
+
+// Passamos o objeto contruido para o handler
+$processor = new ProcessHandler($cnab);
+
+$processor->getDispatcher()->addListener(RetornoEvents::ON_DETAIL_REGISTER,
+                                         function(OnDetailRegisterEvent $event) use($self, &$count) {
+    echo $event->getLineNumber() . PHP_EOL;
+});
+
 ```
 
+Atualmente temos os seguintes eventos:
+
+| **Evento**             |  **Event Class**         | **Descrição**                            |
+|------------------------|--------------------------|------------------------------------------|
+| **ON_DETAIL_REGISTER** | OnDetailRegisterEvent    | Lançado sempre que um registro é iterado | 
+
+
 API
 ----------