An OpenCage Geocoder API wrapper written in Elixir
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
lib
test
.gitignore
.travis.yml
LICENSE
README.md
mix.exs
mix.lock

README.md

OpenCagex

Build Status Hex Version

An OpenCage Geocoder API wrapper written in Elixir

Installation

  1. Add open_cagex to your list of dependencies in mix.exs:
def deps do
  [{:open_cagex, "~> 0.1.0"}]
end

Usage

iex> OpenCagex.set_api_key("YOUR API KEY")
:ok
iex> OpenCagex.geocode("Passatge de la Pau, Barcelona")
{:ok, %{"lat" => 41.3778504, "lng" => 2.1778608}}

iex> OpenCagex.reverse(41.3780845, 2.1751182)
{:ok, "Moog, Carrer de l'Arc del Teatre, 3, 08001 Barcelona, Spain"}

Documentation can be found on HexDocs.

Running locally

Clone the repository

git clone git@github.com:dsantosmerino/open-cagex.git

Install dependencies

cd open_cagex
mix deps.get

To run the tests

mix test

To run the lint

mix credo