From 0ee1e81bd58eb05839fc933383a09100d24fb2d7 Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 6 Sep 2016 09:25:34 +0100 Subject: Mix new --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..6f0bade --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Zendex + +**TODO: Add description** + +## Installation + +If [available in Hex](https://hex.pm/docs/publish), the package can be installed as: + + 1. Add `zendex` to your list of dependencies in `mix.exs`: + + ```elixir + def deps do + [{:zendex, "~> 0.1.0"}] + end + ``` + + 2. Ensure `zendex` is started before your application: + + ```elixir + def application do + [applications: [:zendex]] + end + ``` + -- cgit v1.2.1