README.md
1# Distillery
2
3[](https://travis-ci.org/bitwalker/distillery)
4[](https://hex.pm/packages/distillery)
5[](https://coveralls.io/github/bitwalker/distillery?branch=master)
6
7Every alchemist requires good tools, and one of the greatest tools in the alchemist's disposal
8is the distillery. The purpose of the distillery is to take something and break it down to its
9component parts, reassembling it into something better, more powerful. That is exactly
10what this project does - it takes your Mix project and produces an Erlang/OTP release, a
11distilled form of your raw application's components; a single package which can be deployed anywhere,
12independently of an Erlang/Elixir installation. No dependencies, no hassle.
13
14This is a pure-Elixir, dependency-free implementation of release generation for Elixir projects.
15It is currently a standalone package, but may be integrated into Mix at some point in the future.
16
17## Installation
18
19Distillery requires Elixir 1.3 or greater. It works with Erlang 18+.
20
21```elixir
22defp deps do
23 [{:distillery, "~> 1.5", runtime: false}]
24end
25```
26
27Just add as a mix dependency and use `mix release`. This is a replacement for exrm, but is in beta at this time.
28
29If you are new to releases, please review the [documentation](https://hexdocs.pm/distillery).
30
31## Community/Questions/etc.
32
33If you have questions or want to discuss Distillery, releases, or other deployment
34related topics, a good starting point is the Deployment section of ElixirForum, which
35can be found [here](https://elixirforum.com/c/dedicated-sections/deployment).
36
37I can often be found in IRC on freenode, in the `#elixir-lang` channel, and there is
38also an [Elixir Slack channel](https://elixir-slackin.herokuapp.com) as well, though I don't frequent that myself, there are
39many people who can answer questions there.
40
41Failing that, feel free to open an issue on the tracker with questions, and I'll do my
42best to get to it in a timely fashion!
43
44## License
45
46MIT. See the `LICENSE.md` in this repository for more details.
47
){kind=link}
){kind=link}
){kind=link}