Packages

pigeon

0.12.1
2.0.1 2.0.0 2.0.0-rc.3 2.0.0-rc.2 2.0.0-rc.1 2.0.0-rc.0 1.6.3 1.6.2 1.6.1 1.6.0 1.5.1 1.5.0 1.4.0 1.3.2 1.3.1 1.3.0 1.2.4 1.2.3 1.2.2 1.2.1 1.2.0 1.1.6 1.1.5 1.1.4 1.1.3 1.1.2 1.1.1 1.1.0 1.1.0-rc.1 1.1.0-rc.0 1.0.4 1.0.3 1.0.2 1.0.1 1.0.0 0.13.1 0.13.0 0.12.1 0.12.0 0.11.0 0.10.3 0.10.2 0.10.1 0.10.0 0.9.1 0.9.0 0.8.0 0.7.0 0.6.0 0.5.2 0.5.1 0.5.0 0.4.1 0.4.0 0.3.0 0.2.0 0.1.0

iOS (APNS), Android (FCM), and Amazon Android (ADM) push notifications for Elixir.

HexDocs

Current section

Files

Jump to
Readme
57 Versions
4 Dependencies
2 Dependants
Files
Activity
pigeon README.md
Raw

README.md 

[![Build Status](https://travis-ci.org/codedge-llc/pigeon.svg?branch=master)](https://travis-ci.org/codedge-llc/pigeon)

[![Hex.pm](http://img.shields.io/hexpm/v/pigeon.svg)](https://hex.pm/packages/pigeon) [![Hex.pm](http://img.shields.io/hexpm/dt/pigeon.svg)](https://hex.pm/packages/pigeon)

[![Deps Status](https://beta.hexfaktor.org/badge/all/github/codedge-llc/pigeon.svg)](https://beta.hexfaktor.org/github/codedge-llc/pigeon)

# Pigeon

HTTP2-compliant wrapper for sending iOS and Android push notifications.



## Installation

**Note: Pigeon's API will likely change until v1.0**



Add pigeon and kadabra as `mix.exs` dependencies:

  ```elixir

  def deps do

    [

      {:pigeon, "~> 0.12.0"},

      {:kadabra, "~> 0.2.0"}

    ]

  end

  ```

  

After running `mix deps.get`, if running Elixir `v1.3` or earlier, configure `mix.exs`

to start the applications automatically.

  ```elixir

  def application do

    [applications: [:pigeon, :kadabra]]

  end

  ```

  



Prefer `chatterbox` as your http2 client?

  ```elixir

  def deps do

    [

      {:pigeon, "~> 0.12.0"},

      {:chatterbox, "~> 0.4.0"}

    ]

  end

  ```



Specify it in your `config.exs`

  ```elixir

  :config, :pigeon, http2_client: Pigeon.Http2.Client.Chatterbox

  ```



## Getting Started

For usage and configuration, see the docs:

* [APNS (Apple iOS)](https://hexdocs.pm/pigeon/apns-apple-ios.html)

* [GCM (Android)](https://hexdocs.pm/pigeon/gcm-android.html)

* [ADM (Amazon Android)](https://hexdocs.pm/pigeon/adm-amazon-android.html)