Skip to content

Commit

Permalink
Adjusting README
Browse files Browse the repository at this point in the history
  • Loading branch information
ygorlazaro committed Mar 27, 2019
1 parent 1865759 commit 3560ce7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ Ferramenta de pesquisa de cep para node e JavaScript client-side. Utiliza como b

Como desenhado até o momento, a biblioteca é compatível com qualquer framework front-end, como React, React Native, Vue.JS, Angular e AngularJS.

## Ajude o projeto! https://github.com/ygorlazaro/buscadorcep

# Versão 2.0.0

- Melhoria de velocidade
- Breaking change: `axios` removido como dependência, o retorno do método agora não tem mais o "envelope" `AxiosResponse`

# Como utilizar

Instale o componente:
Expand All @@ -23,7 +30,7 @@ const buscadorcep = require('buscadorcep');
const endereco = await buscadorcep('21235280');
console.log(endereco.data);
console.log(endereco);
/*
retorno:
Expand All @@ -46,11 +53,6 @@ Como o serviço retorna uma Promise, é possível utilizar encadeamento de `.the

```
buscadorcep('21235280')
.then(response => response.data)
.then(response => response)
.then(endereco => console.log(endereco));
```

# Roadmap

* Componente visual para React
* Diretiva de Vue.JS
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "buscadorcep",
"version": "1.1.0",
"version": "2.0.0",
"description": "Ferramenta de pesquisa de CEP para node e client-side",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 3560ce7

Please sign in to comment.