Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.45 KB

README.md

File metadata and controls

49 lines (33 loc) · 1.45 KB

GoogleRoads

Elixir wrapper for Google Roads API based in sntran/ex_maps

Build Status Hex Version License

  • Snap to roads - Best-fit road geometry for a given set of GPS coordinates
  • Nearest roads - Closest road segment for a given set of GPS coordinates
  • Speed limits - Posted speed limit for a given road segment

Methods

  • snap_to_roads/3
  • get/2

Development

You'll need a Google API key with all relevant APIs (see above) enabled. Add your key to the environment as specified above.

Then run tests:

mix deps.get test

mix test

Setup credentials

In your config/config.exs:

config :google_roads,
  api_key: "your_api_key"

Installation

If available in Hex, the package can be installed by adding ex_roads to your list of dependencies in mix.exs:

def deps do
  [
    {:ex_roads, "~> 0.0.1"}
  ]
end