README.md in open_street_map-1.0 vs README.md in open_street_map-1.1
- old
+ new
@@ -1,8 +1,8 @@
# OpenStreetMap
-Integration of OpenStreetMap api from [Nominatim](https://wiki.openstreetmap.org/wiki/Nominatim)
+Integration of OpenStreetMap api from [Nominatim](https://wiki.openstreetmap.org/wiki/Nominatim)
## Installation
Add this line to your application's Gemfile:
@@ -29,21 +29,25 @@
### Search
Request for search objects is #search.
```ruby
- client.search(q: '135 pilkington avenue, birmingham', format: 'json', addressdetails: '1')
+ client.search(q: '135 pilkington avenue, birmingham', format: 'json', addressdetails: '1', accept_language: 'ru')
```
q - query
format - one of the [xml|json|jsonv2]
viewbox - The preferred area to find search results like <x1>,<y1>,<x2>,<y2>
bounded - Restrict the results to only items contained with the viewbox, one of the [0|1]
addressdetails - Include a breakdown of the address into elements, one of the [0|1]
exclude_place_ids - If you do not want certain openstreetmap objects to appear in the search result, give a comma separated list of the place_id's you want to skip
limit - Limit the number of returned results, integer
extratags - Include additional information in the result if available, one of the [0|1]
namedetails - Include a list of alternative names in the results, one of the [0|1]
+ accept_language - Preferred language order for showing search results, default - en
+ email - If you are making large numbers of request please include a valid email address
+ user_agent - User-Agent identifying the application, default - webgents/open_street_map_gem_random
+ hostname - allow overwriting the host name for users who have their own Nominatim installation, default - https://nominatim.openstreetmap.org/
#### Responces
```ruby
[
@@ -78,19 +82,23 @@
### Reverse
Request for objects by coordinates is #reverse.
```ruby
- client.reverse(format: 'json', lat: '52.594417', lon: '39.493115')
+ client.reverse(format: 'json', lat: '52.594417', lon: '39.493115', accept_language: 'ru')
```
format - one of the [xml|json|jsonv2]
zoom - Level of detail required where 0 is country and 18 is house/building, one of the [0-18]
addressdetails - Include a breakdown of the address into elements, one of the [0|1]
lat - Latitude, required
lon - Longitude, required
extratags - Include additional information in the result if available, one of the [0|1]
namedetails - Include a list of alternative names in the results, one of the [0|1]
+ accept_language - Preferred language order for showing search results, default - en
+ email - If you are making large numbers of request please include a valid email address
+ user_agent - User-Agent identifying the application, default - webgents/open_street_map_gem_random
+ hostname - allow overwriting the host name for users who have their own Nominatim installation, default - https://nominatim.openstreetmap.org/
#### Responces
```ruby
{
@@ -122,5 +130,9 @@
Bug reports and pull requests are welcome on GitHub at https://github.com/WebGents/open_street_map.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Disclaimer
+
+Use this package at your own peril and risk, the author tried to simplify the use of [Nominatim service](https://wiki.openstreetmap.org/wiki/Nominatim) for integration into Ruby on Rails web applications.