From c23f33994cb7f251e4a80284181cb9078e0998ac Mon Sep 17 00:00:00 2001
From: Danielpk <contato@danielpk.com.br>
Date: Tue, 30 Mar 2010 16:02:33 -0300
Subject: [PATCH] Adicionado os textos do README.

---
 README | 100 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 100 insertions(+)

diff --git a/README b/README
index e69de29..1d72a54 100644
--- a/README
+++ b/README
@@ -0,0 +1,100 @@
+h1. Plugin Boletos CakePHP
+
+Plugin que integra o projeto BoletoPHP com o CakePHP.
+
+O Plugin precisa de algumas "melhorias" que vou estar fazendo em breve.
+
+h1. Bancos
+
+Atualmente o Plugin tem suporte apenas ao Banco do Brasil.
+
+h1. Instalação
+
+Coloque os arquivos em app/plugin/boletos.
+
+h2. Arquivo de Configuração
+
+O Plugin tenta localizar as configurações no arquivo boleto_bb.php que fica dentro da pasta config, se ele não achar na pasta do config ele vai carregar o que está dentro do config do plugin.
+
+*Conteúdo do arquivo:*
+<pre>
+<?php
+
+/* Informações da sua conta */
+$config['Boleto']["agencia"] = "9999"; // Num da agencia, sem digito
+$config['Boleto']["conta"] = "9999"; 	// Num da conta, sem digito
+
+/* Dados do contrato com o Banco */
+$config['Boleto']["convenio"] = "2222222";  // Num do convênio - REGRA: 6 ou 7 ou 8 dígitos
+$config['Boleto']["contrato"] = "2222222"; // Num do seu contrato
+$config['Boleto']["carteira"] = "18";
+$config['Boleto']["variacao_carteira"] = "-019";  // Variação da Carteira, com traço (opcional)
+
+/* Tipo do Boleto */
+$config['Boleto']["formatacao_convenio"] = "7"; // REGRA: 8 p/ Convênio c/ 8 dígitos, 7 p/ Convênio c/ 7 dígitos, ou 6 se Convênio c/ 6 dígitos
+$config['Boleto']["formatacao_nosso_numero"] = "2"; // REGRA: Usado apenas p/ Convênio c/ 6 dígitos: informe 1 se for NossoNúmero de até 5 dígitos ou 2 para opção de até 17 dígitos
+
+/* Seus Dados */
+$config['Boleto']["identificacao"] = "CakePHP Boletos";
+$config['Boleto']["cpf_cnpj"] = "00.000.000/0001-00";
+$config['Boleto']["endereco"] = "Rua de teste, 88";
+$config['Boleto']["cidade_uf"] = "São Paulo / SP";
+$config['Boleto']["cedente"] = "Minha Empresa Ltda.";
+
+/* Vence em quantos dias? */
+$config['Boleto']['dias_vencimento'] = 5;
+
+/* Taxa do boleto */
+$config['Boleto']['taxa'] = 0;
+
+/* Informações para o cliente*/
+$config['Boleto']["demonstrativo1"] = "Pagamento dos produtos comprados no<br />";
+$config['Boleto']["demonstrativo2"] = "CakePHP Boletos.<br />";
+$config['Boleto']["demonstrativo3"] = "";
+
+/* Instruções ao caixa*/
+$config['Boleto']["instrucoes1"] = " Sr. Caixa,";
+$config['Boleto']["instrucoes2"] = " Não receber após o vencimento.";
+$config['Boleto']["instrucoes3"] = "";
+$config['Boleto']["instrucoes4"] = "";
+
+/* OPCIONAIS */
+$config['Boleto']["quantidade"] = "";
+$config['Boleto']["valor_unitario"] = "";
+
+/* MOEDA */
+$config['Boleto']["aceite"] = "N";
+$config['Boleto']["especie"] = "R$";
+$config['Boleto']["especie_doc"] = "DM";
+
+?>
+</pre>
+
+h2. Carregando o Component
+
+Dentro do controller carregue o component:
+
+<pre>
+var $components = array('Boletos.BoletoBb');
+</pre>
+
+Metódo de exemplo para renderizar o boleto:
+
+<pre>
+function index(){
+		$this->autoRender = false;
+		$dados = array(
+			'sacado' => 'Fulano de Tal',
+			'endereco1' => 'Rua do funal de tal, 88',
+			'endereco2' => 'Curitiba/PR',
+			'valor_cobrado' => 100.56,
+			'pedido' => 5 // Usado para gerar o número do documento e o nosso número.
+		);
+		$this->BoletoBb->render($dados);
+	}
+</pre>
+
+Pronto. 
+O Boleto já está instalado e pronto para ser usado.
+
+