Elixir wrapper for the What3words API
Elixir
Fetching latest commitโ€ฆ
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
lib
test
.gitignore
LICENSE
README.md
mix.exs
mix.lock

README.md

what3words Elixir wrapper

Use the what3words API in your Elixir app (see the API documentation). ๐Ÿš€

Hey, version 2.0 is out! ๐ŸŽถ Have a look at the hexdocs to see what's changed!

Installation

Pretty straightforward! Add the dependency to your mix.exs:

  def deps do
    [{:what3words, "~> 2.0.0"}]
  end

add :what3words to the applications to be started:

  def application do
    [applications: [:logger, :what3words]]
  end

and add your API key to your config.exs (get one here):

config :what3words, key: "mykey"

You should be good to go! ๐Ÿ‘๐Ÿป

Usage

Hexdocs to the rescue! ๐Ÿ‘‹๐Ÿป

Contributing

  • Fork this repo
  • Create your feature branch (git checkout -b my-new-feature)
  • Commit your changes (git commit -am 'Add some feature')
  • Push to the branch (git push origin my-new-feature)
  • Create a new Pull Request

License

See LICENSE