README.md

# Phoenix.PubSub
> Distributed PubSub and Presence platform for the Phoenix Framework

[![Build Status](https://api.travis-ci.org/phoenixframework/phoenix_pubsub.svg)](https://travis-ci.org/phoenixframework/phoenix_pubsub)


## Installation


  1. Add phoenix_pubsub to your list of dependencies in `mix.exs`:

  ```elixir
  def deps do
    [{:phoenix_pubsub, "~> 1.0"}]
  end
  ```

  2. Ensure phoenix_pubsub is started before your application:

  ```elixir
  def application do
    [applications: [:phoenix_pubsub]]
  end
  ```


## Testing

Testing by default spawns nodes internally for distributed tests.
To run tests that do not require clustering, exclude  the `clustered` tag:

    $ mix test --exclude clustered

If you have issues running the clustered tests try running:

    $ epmd -daemon

before running the tests.