README.md in regio-0.1.1 vs README.md in regio-0.2.0
- old
+ new
@@ -9,11 +9,11 @@
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'regio', '~> 0.1.1'
+gem 'regio', '~> 0.2.0'
```
And then execute:
$ bundle
@@ -28,12 +28,14 @@
```shell
REGIO_API_KEY=SECRET
```
-Use geocode class in your code
+### Geocoding
+Use `Geocode` class in your code
+
```ruby
require 'regio'
class Geocoding
@@ -49,9 +51,38 @@
country: 'ee'
}
end
end
```
+
+Check Regio [geocode](https://api.regio.ee/documentation/#docs/geocode) documentation
+
+
+### Reverse geocoding
+
+Use `ReverseGeocode` class in your code
+
+```ruby
+require 'regio'
+
+class Geocoding
+
+ private
+
+ def results
+ @results ||= Regio::ReverseGeocode.new(options).results
+ end
+
+ def options
+ {
+ lat: 59.4276340999273,
+ lng: 24.7790924770962
+ }
+ end
+end
+```
+
+Check Regio [reverse geocode](https://api.regio.ee/documentation/#docs/reverse_geocode) documentation
## 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.