Merge branch 'master' of https://github.com/Infanatica/InfanaticaCepM…

…odule
Infanatica · Feb 12, 2015 · dd57dd0 · dd57dd0
2 parents ea4cabb + 5eaf37f
commit dd57dd0
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -4,10 +4,48 @@ Módulo em Zend Framework 2 para consulta de endereço via CEP
 
 # Instalação
 
-- Clonar o projeto na pasta vendor ou module no seu projeto do Zend
-- Adicionar ao seu arquivo `application.config.php` 
+#### Instalação via clone
 
-    ```php
+Clonar o projeto [InfanaticaCepModule](https://github.com/Infanatica/InfanaticaCepModule.git) na pasta "./vendor" ou "./module" no seu projeto em Zend Framework 2
+
+```bash
+    $ cd PASTA_DO_SKELETON_DO_ZEND_FRAMEWORK2
+    $ cd vendor
+    $ git clone https://github.com/Infanatica/InfanaticaCepModule.git
+```
+
+#### Instalação via composer
+
+###### Método 1
+
+Adicionar o projeto [InfanaticaCepModule](https://packagist.org/packages/infanatica/infanatica-cep-module) no seu composer.json:
+
+
+```json
+    "require": {
+        "infanatica/infanatica-cep-module": "dev-master"
+    }
+```
+Executar o comando "update" ou "install" do composer para fazer download do [InfanaticaCepModule](https://packagist.org/packages/infanatica/infanatica-cep-module)
+
+```bash
+    $ php composer.phar update
+```
+
+###### Método 2
+
+Executar o comando "require" do composer para atualizar o seu composer.json e efetuar o download do [InfanaticaCepModule](https://packagist.org/packages/infanatica/infanatica-cep-module)
+
+```bash
+	php composer.phar require infanatica/infanatica-cep-module dev-master
+```
+
+
+#### Após a Instalação
+
+Adicionar ao seu arquivo `application.config.php` 
+
+```php
     <?php
     return array(
         'modules' => array(
@@ -16,23 +54,38 @@ Módulo em Zend Framework 2 para consulta de endereço via CEP
         ),
         // ...
     );
-    ```
-
-#Utilização do Service (Exemplo no Controller)
+```
 
-$cep = '21041020';
+# Utilização do Service 
+#### Exemplo no \Application\Controller\InderController
 
-// Possíveis formatos (json, xml, query, object, array) 
+```php
+	<?php
+	//...
+	class IndexController extends AbstractActionController
+	{
+		public function indexAction()
+	    {
+			$cep = '21041020';
 
-// null = \InfanaticaCepModule\Response\EnderecoResponse
+			// Possíveis formatos (json, xml, query, object, array)
+			// null = \InfanaticaCepModule\Response\EnderecoResponse
+			$formato        = 'json';
 
-$formato = 'json'; 
+			$serviceLocator = $this->getServiceLocator();
+			$cepService     = $serviceLocator->get('InfanaticaCepModule\Service\CepService');
+			$endereco       = $cepService->getEnderecoByCep($cep,$formato);
+			var_dump($endereco);
 
-$cepService = $this->getServiceLocator->get('InfanaticaCepModule\Service\CepService');
+	        return new ViewModel();
+	    }
+    //...
+```
 
-$endereco = $this->cepService->getEnderecoByCep($cep,$formato);
+# Utilização do Controller 
+#### Exemplos de rota para:
+#### \InfanaticaCepModule\Controller\CepController
 
-#Utilização do Controller
 
 http[s]://domain/cep/NUMERO_DO_CEP</div>
 
@@ -44,15 +97,17 @@ http[s]://domain/cep/21041020/json
 
 http[s]://domain/cep/21041020/xml
 
-#Referências dos Adapters de pesquisa de CEP
 
-ViaCEP - http://viacep.com.br/ (Concluído)
+# Referências dos Adapters de pesquisa de CEP
+
+[ViaCEP](http://viacep.com.br/) (Concluído)
+
+[Postmon](http://postmon.com.br/) (Concluído)
 
-Postmon - http://postmon.com.br/ (Concluído)
+[Correio Control](http://avisobrasil.com.br/correio-control/api-de-consulta-de-cep/) (Concluído)
 
-Correio Control - http://avisobrasil.com.br/correio-control/api-de-consulta-de-cep/ (Concluído)
 
-#Contruibuidores
+# Contruibuidores
 
 Diogo Oliveira Mascarenhas (https://github.com/diogomascarenha)
 

diff --git a/composer.json b/composer.json
@@ -1,14 +1,12 @@
 {
-  "name": "infanatica/InfanaticaCepModule",
-  "description": "Módulo em Zend Framework 2 para consulta de endereço via CEP",
+  "name": "infanatica/infanatica-cep-module",
+  "description": "Modulo em Zend Framework 2 para consulta de endereco via CEP",
   "tyoe": "library",
   "license": "BSD-3-Clause",
   "keywords": [
     "cep",
     "correios",
     "endereco",
-    "endereço",
-    "module",
     "modulo",
     "zf2",
     "zend",