summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTiago Freire <tcfonnet@gmail.com>2016-07-22 09:18:21 -0300
committerTiago Freire <tcfonnet@gmail.com>2016-07-25 10:51:14 -0300
commitcad149156ee46ec9feb4929dc1ed5d60a4f4f44e (patch)
treea36f8548f7b220f7846d7c4f77d03d5ab55bd390 /README.md
[WIP] Init.
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..08ed556
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# PowerDNSx
+
+**TODO: Add description**
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
+
+ 1. Add `powerdnsx` to your list of dependencies in `mix.exs`:
+
+ ```elixir
+ def deps do
+ [{:powerdnsx, "~> 0.1.0"}]
+ end
+ ```
+
+ 2. Ensure `powerdnsx` is started before your application:
+
+ ```elixir
+ def application do
+ [applications: [:powerdnsx]]
+ end
+ ```
+