Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.5 KB

README.md

File metadata and controls

57 lines (38 loc) · 1.5 KB

Phoenix.Swoosh

Build Status Inline docs Deps Status

Use Swoosh to easily send emails in your Phoenix project.

This module provides the ability to set the HTML and/or text body of an email by rendering templates.

See the docs for more information.

Installation

  1. Add phoenix_swoosh to your list of dependencies in mix.exs:
```elixir
def deps do
  [{:phoenix_swoosh, "~> 0.2"}]
end
```
  1. Ensure phoenix_swoosh is started before your application:
```elixir
def application do
  [applications: [:phoenix_swoosh]]
end
```

Documentation

Documentation is written into the library, you will find it in the source code, accessible from iex and of course, it all gets published to hexdocs.

Contributing

Running tests

Clone the repo and fetch its dependencies:

$ git clone https://github.com/swoosh/phoenix_swoosh.git
$ cd phoenix_swoosh
$ mix deps.get
$ mix test

Building docs

$ MIX_ENV=docs mix docs

LICENSE

See LICENSE