# viacep  [](https://github.com/vnbrs/burocracia.cr/blob/master/LICENSE)
> Dependency-less zipcode lookup gem for Brazilian addresses with an easy-to-use API and useful features such as timeout.
## Installing
You can easily install viacep through [RubyGems](https://rubygems.org/gems/viacep/):
```shell
gem install viacep
=> Rock on! 🚀
```
or add the following to your Gemfile:
```shell
gem "viacep"
```
## Usage
```ruby
require 'viacep'
# with unformatted zipcodes... =)
ViaCep::Address.new('80210130')
=> #
# with formatted zipcodes... =)
ViaCep::Address.new('13035-680')
=> #
# or even an nonexistent zipcode... =(
ViaCep::Address.new('12345678')
=> exception thrown: ViaCep::ApiRequestError
# and specifying a timeout in seconds... =)
ViaCep::Address.new('80210130', timeout: 0.2)
=> exception thrown: Timeout::Error (execution expired)
```
## Contributing
1. Create a fork (https://github.com/vnbrs/viacep/fork)
2. Create a branch (git checkout -b my-new-feature)
3. Make a commit (git commit -am 'Add some feature')
4. Push your code (git push origin my-new-feature)
5. Create a Pull Request
6. Thanks! 🤙🏼