README.md in regio-0.1.0 vs README.md in regio-0.1.1

- old
+ new

@@ -1,17 +1,19 @@ # Regio +[![Gem Version](https://badge.fury.io/rb/regio.svg)](https://badge.fury.io/rb/regio) + [Regio geocoding API](https://api.regio.ee/documentation/#docs/geocode) lets you search for addresses from complete Estonian address database. [Regio](https://www.regio.ee/en/) ## Installation Add this line to your application's Gemfile: ```ruby -gem 'regio' +gem 'regio', '~> 0.1.1' ``` And then execute: $ bundle @@ -20,10 +22,36 @@ $ gem install regio ## Usage -TODO: Write usage instructions here +Get your own API key + +```shell +REGIO_API_KEY=SECRET +``` + +Use geocode class in your code + +```ruby +require 'regio' + +class Geocoding + + private + + def results + @results ||= Regio::Geocode.new(options).results + end + + def options + { + address: 'Tartu maantee 83', + country: 'ee' + } + end +end +``` ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.