diff --git a/README.md b/README.md index 1f356b9..1f1854f 100644 --- 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 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 + 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 @@ -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 index 146d1d2..2f3c276 100644 --- 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",