aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSteven Blowers <sblowers@findmypast.com>2016-09-06 09:25:34 +0100
committerSteven Blowers <sblowers@findmypast.com>2016-09-06 09:25:34 +0100
commit0ee1e81bd58eb05839fc933383a09100d24fb2d7 (patch)
tree6dff38b6a632dcf4bb12aefaba3fd27886e1a152 /README.md
downloadzendex-0ee1e81bd58eb05839fc933383a09100d24fb2d7.tar.gz
zendex-0ee1e81bd58eb05839fc933383a09100d24fb2d7.tar.xz
Mix new
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
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
+ ```
+