# Phoenix Ratchet

[![Build Status][travis-img]][travis] [![Hex Version][hex-img]][hex]


A [Phoenix][phoenix] template engine for [Ratchet][ratchet].

View the [Documentation][docs].

## Usage

1. Install with Hex:

   def deps do
     [{:phoenix_ratchet, "~> 0.4"}]

1. Configure Phoenix in `config/config.exs` to use the Ratchet engine:

   config :phoenix, :template_engines,
     ratchet: Ratchet.Phoenix.Engine

1. Configure Phoenix in `config/dev.exs` to live reload Ratchet templates:

   config :blurg, Blurg.Endpoint,
     live_reload: [
       patterns: [
  -      ~r{web/templates/.*eex$}
  +      ~r{web/templates/.*(eex|ratchet)$}

An example project can be found at [iamvery/example-ratchet-app][example].

## Release

1. Bump the version in `mix.exs`.
1. Add version to CHANGELOG.
1. Commit version with Git tag `vX.X.X`.
1. Publish to Hex

   $ mix do hex.publish, hex.publish docs