summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
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
+ ```
+