README.md in viacep-2.0.2 vs README.md in viacep-2.0.3
- old
+ new
@@ -1,55 +1,50 @@
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/b/bc/BRA_orthographic.svg/270px-BRA_orthographic.svg.png" align="right" />
-# viacep [](https://github.com/vnbrs/burocracia.cr/blob/master/LICENSE)
-> Gem responsável por buscar endereços a partir do CEP utilizando a API do ViaCEP com features úteis como timeout.
+# 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.
-## Instalação
+## Installing
-Instale o viacep pelo [RubyGems](https://rubygems.org/gems/viacep/) facilmente via terminal:
+You can easily install viacep through [RubyGems](https://rubygems.org/gems/viacep/):
```shell
gem install viacep
-=> Vai que é tua! 🚀
+=> Rock on! 🚀
```
-ou...
+or add the following to your Gemfile:
```shell
-bundle add viacep
-=> Gem instalada no Gemfile! 🤓
+gem "viacep"
```
-## Como usar?
+## Usage
```ruby
require 'viacep'
-# com CEPs sem formatação...
+# with unformatted zipcodes... =)
ViaCep::Address.new('80210130')
=> #<ViaCep::Address:0x00007fe52a8a0568 @cep="80210-130", @address="Rua José Ananias Mauad", @neighborhood="Jardim Botânico", @city="Curitiba", @state="PR", @ibge="4106902", @gia="">
-# com CEPs formatados...
+# with formatted zipcodes... =)
ViaCep::Address.new('13035-680')
=> #<ViaCep::Address:0x00007fe52a99e730 @cep="13035-680", @address="Avenida João Jorge", @neighborhood="Vila Industrial", @city="Campinas", @state="SP", @ibge="3509502", @gia="2446">
-# um CEP não existente...
-ViaCep::Address.new('123')
+# or even an nonexistent zipcode... =(
+ViaCep::Address.new('12345678')
=> exception thrown: ViaCep::ApiRequestError
-# especificando um timeout em segundos...
+# and specifying a timeout in seconds... =)
ViaCep::Address.new('80210130', timeout: 0.2)
=> exception thrown: Timeout::Error (execution expired)
```
-## Contribuindo
+## Contributing
-1. Faça um fork (https://github.com/vnbrs/viacep/fork)
-2. Crie uma branch (git checkout -b my-new-feature)
-3. Faça um commit (git commit -am 'Add some feature')
-4. Faça o push (git push origin my-new-feature)
-5. Crie um Pull Request
-6. Valeu! 🤙🏼
-
-## Contribuidores
-
-- [vnbrs](https://github.com/vnbrs) Vinicius Brasil - creator, maintainer
+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! 🤙🏼