collectiveidea / graticule

Click here to lend your support to: graticule and make a donation at www.pledgie.com !

Graticule is a geocoding API for looking up address coordinates and performing distance calculations, supporting many popular APIs.

This URL has Read+Write access

name age
history
message
file .autotest Thu Oct 08 12:09:19 -0700 2009 Make tests mirror lib directory and add .autote... [brandon]
file .gitignore Mon Sep 21 15:15:23 -0700 2009 Ignore rdoc [brandon]
file CHANGELOG.txt Mon Sep 21 15:23:31 -0700 2009 Added freethepostcode.org geocoder [Chris Lowis] [brandon]
file LICENSE.txt Sat Dec 16 08:01:49 -0800 2006 released 0.1.1 [brandon]
file README.txt Sun Oct 04 17:38:39 -0700 2009 Remove the PostcodeAnywhere geocoder. I don't ... [brandon]
file Rakefile Sat Dec 05 20:57:13 -0800 2009 Version bump to 1.0.0.pre [brandon]
file VERSION Sat Dec 05 20:57:13 -0800 2009 Version bump to 1.0.0.pre [brandon]
directory bin/ Mon Mar 12 10:54:30 -0700 2007 added international geocoders international-ize... [brandon]
file graticule.gemspec Sat Dec 05 20:57:13 -0800 2009 Version bump to 1.0.0.pre [brandon]
file init.rb Fri Dec 15 20:35:27 -0800 2006 migrated to hoe added other distance calculations [brandon]
directory lib/ Thu Oct 22 10:20:00 -0700 2009 Added Google's api key back in. Apparently it ... [brandon]
directory site/ Sun Nov 23 16:02:34 -0800 2008 removed unnecessary style [brandon]
directory test/ Thu Oct 22 10:20:00 -0700 2009 Added Google's api key back in. Apparently it ... [brandon]
README.txt
= Graticule

Graticule is a geocoding API for looking up address coordinates.  It supports many popular APIs, including Yahoo, 
Google, Geocoder.ca and Geocoder.us.

= Usage

  require 'rubygems'
  require 'graticule'
  geocoder = Graticule.service(:google).new "api_key"
  location = geocoder.locate "61 East 9th Street, Holland, MI"

= Distance Calculation

Graticule includes 3 different distance formulas, Spherical (simplest but least accurate), Vincenty (most accurate and 
most complicated), and Haversine (somewhere inbetween).

  geocoder.locate("Holland, MI").distance_to(geocoder.locate("Chicago, IL"))
  #=> 101.997458788177
  
= Command Line

Graticule includes a command line interface (CLI).

  $ geocode -s yahoo -a yahookey Washington, DC
  Washington, DC US
  latitude: 38.895222, longitude: -77.036758

= Mailing List

Join us on the mailing list at http://groups.google.com/group/graticule

= How to contribute

If you find what you might think is a bug:

1. Check the GitHub issue tracker to see if anyone else has had the same issue.
   http://github.com/collectiveidea/graticule/issues/
2. If you don't see anything, create an issue with information on how to reproduce it.

If you want to contribute an enhancement or a fix:

1. Fork the project on github.
   http://github.com/collectiveidea/graticule/
2. Make your changes with tests.
3. Commit the changes without making changes to the Rakefile, VERSION, or any other files that aren't related to your 
enhancement or fix
4. Send a pull request.