easyplace/README.md

API to search for ceps, streets, neighborhoods and other places

# EasyPlace

This project provides an API to search for places such as streets, neighborhoods, cities and so on. It's made upon the [ViaCEP project](https://viacep.com.br/) of [IBGE](https://www.ibge.gov.br/).

## Uses
```
const findAddresssUsingCep = async (cep) => {
    try {
        const address = await EasyPlace.getAddressOfCep(cep);
        console.log(address);
    } catch (e) {
        console.log(e.message);
    }
}

findAddresssUsingCep("57055800");


const getPlaces = async (wordsInStreetName, city, state, neighborhood) => {
    try {
        const places = await EasyPlace.searchStreetWithName(wordsInStreetName)
                                      .inCity(city)
                                      .inState(state)
                                      .inNeighborhood(neighborhood)
                                      .search();
        console.log(places);
    } catch (e) {
        console.log(e);
    }
}

getPlaces(["arroxelas"], "Maceio", "AL", "Ponta Verde");
```

## Bugs
+ No one yet :)

## Contribuitors
+ Aurelio Buarque (https://github.com/ABuarque)