https://github.com/oscar-lopez/exurban

Elixir wrapper for UrbanAirship API.
https://github.com/oscar-lopez/exurban

Last synced: 3 months ago
JSON representation

Elixir wrapper for UrbanAirship API.

• Host: GitHub
• URL: https://github.com/oscar-lopez/exurban
• Owner: oscar-lopez
• License: other
• Created: 2014-11-10T20:02:30.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-12-02T20:06:58.000Z (about 10 years ago)
• Last Synced: 2024-08-02T02:14:05.720Z (6 months ago)
• Language: Elixir
• Size: 155 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Elixir wrapper for UrbanAirship API. (Third Party APIs)
• fucking-awesome-elixir - exurban - Elixir wrapper for UrbanAirship API. (Third Party APIs)
• awesome-elixir - exurban - Elixir wrapper for UrbanAirship API. (Third Party APIs)

README

        
# ExUrban #

Elixir wrapper for UrbanAirship API. This is a work in progress.

## Installation ##

Add as a dependency to your application:

```elixir

defp deps do

  [{:exurban, "~> 0.0.1"}]

end

```

Start `ExUrban` within your application:

```elixir

def applications do

  [applications: [:logger, :exurban]]

end

```

Install and compile the dependencies:

```shell

$ mix do deps.get, compile

```

## Configuration ##

You should add your API keys to your `config/#{env}.exs`.

## Documentation ##

Brief usage:

```shell

iex -S mix

...

iex> ExUrban.start

iex> ExUrban.push %{notification: ...}

```

You can pass a map with all the options and values you want. For more

information about the fields please refer to the official Urban

Airship documentation.

## Testing ##

```shell

$ mix test

```

## Contributing ##

Fork the repo and work on a branch. Once you have your feature, bugfix

or anything ready commit please create a new pull request.

## Status ##

*Alpha quality*.

## License ##

Simplified BSD License. See `LICENSE`.