Phoenix Ratchet

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

A Phoenix template engine for Ratchet.

View the Documentation.

Usage

  1. Install with Hex:
   def deps do
     [{:phoenix_ratchet, "~> 0.4"}]
   end
  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{priv/static/.*(js|css|png|jpeg|jpg|gif|svg)$},
         ~r{priv/gettext/.*(po)$},
         ~r{web/views/.*(ex)$},
  -      ~r{web/templates/.*eex$}
  +      ~r{web/templates/.*(eex|ratchet)$}
       ]
     ]

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

Release

  1. Bump the version in mix.exs.
  2. Add version to CHANGELOG.
  3. Commit version with Git tag vX.X.X.
  4. Publish to Hex
   $ mix do hex.publish, hex.publish docs