README.md in geocoder-1.2.11 vs README.md in geocoder-1.2.12

- old
+ new

@@ -45,11 +45,11 @@ Your model must have two attributes (database columns) for storing latitude and longitude coordinates. By default they should be called `latitude` and `longitude` but this can be changed (see "Model Configuration" below): rails generate migration AddLatitudeAndLongitudeToModel latitude:float longitude:float rake db:migrate -For reverse geocoding your model must provide a method that returns an address. This can be a single attribute, but it can also be a method that returns a string assembled from different attributes (eg: `city`, `state`, and `country`). +For geocoding your model must provide a method that returns an address. This can be a single attribute, but it can also be a method that returns a string assembled from different attributes (eg: `city`, `state`, and `country`). Next, your model must tell Geocoder which method returns your object's geocodable address: geocoded_by :full_street_address # can also be an IP address after_validation :geocode # auto-fetch coordinates @@ -292,11 +292,11 @@ Every `Geocoder::Result` object, `result`, provides the following data: * `result.latitude` - float * `result.longitude` - float -* `result.coordinates` - array of the above two +* `result.coordinates` - array of the above two in the form of `[lat,lon]` * `result.address` - string * `result.city` - string * `result.state` - string * `result.state_code` - string * `result.postal_code` - string @@ -349,10 +349,14 @@ Please see the [source code for each lookup](https://github.com/alexreisner/geocoder/tree/master/lib/geocoder/lookups) to learn about directly supported parameters. Parameters which are not directly supported can be specified using the `:params` option, by which you can pass arbitrary parameters to any geocoding service. For example, to use Nominatim's `countrycodes` parameter: # with Nominatim: Geocoder.search("Paris", :params => {:countrycodes => "gb,de,fr,es,us"}) +Or, to search within a particular region with Google: + + Geocoder.search("...", :params => {:region => "..."}) + You can also configure multiple geocoding services at once, like this: Geocoder.configure( :timeout => 2, @@ -462,13 +466,13 @@ * **Documentation**: http://geocoder.opencagedata.com/api.html * **Limitations**: [Data licensed under Open Database License (ODbL) (you must provide attribution).](http://www.openstreetmap.org/copyright) #### Yandex (`:yandex`) -* **API key**: none +* **API key**: optional, but without it lookup is territorially limited * **Quota**: 25000 requests / day -* **Region**: world +* **Region**: world with API key. Otherwise restricted to Russia, Ukraine, Belarus, Kazakhstan, Georgia, Abkhazia, South Ossetia, Armenia, Azerbaijan, Moldova, Turkmenistan, Tajikistan, Uzbekistan, Kyrgyzstan and Turkey * **SSL support**: HTTPS only * **Languages**: Russian, Belarusian, Ukrainian, English, Turkish (only for maps of Turkey) * **Documentation**: http://api.yandex.com.tr/maps/doc/intro/concepts/intro.xml * **Terms of Service**: http://api.yandex.com.tr/maps/doc/intro/concepts/intro.xml#rules * **Limitations**: ? @@ -497,11 +501,11 @@ * **Limitations**: ? #### Mapquest (`:mapquest`) * **API key**: required -* **Key signup**: http://developer.mapquest.com/web/products/open +* **Key signup**: https://developer.mapquest.com/plans * **Quota**: ? * **HTTP Headers**: when using the licensed API you can specify a referer like so: `Geocoder.configure(:http_headers => { "Referer" => "http://foo.com" })` * **Region**: world * **SSL support**: no @@ -1073,8 +1077,9 @@ * Do not add dependencies on other gems. * Do not add unnecessary `require` statements which could cause LoadErrors on certain systems. * Remember: Geocoder needs to run outside of Rails. Don't assume things like ActiveSupport are available. * Be willing to accept criticism and work on improving your code; Geocoder is used by thousands of developers and care must be taken not to introduce bugs. * Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request. +* If your pull request is merged, please do not ask for an immediate release of the gem. There are many factors contributing to when releases occur (remember that they affect thousands of apps with Geocoder in their Gemfiles). If necessary, please install from the Github source until the next official release. Copyright (c) 2009-15 Alex Reisner, released under the MIT license