summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGustaf Rydholm <gustaf.rydholm@gmail.com>2024-08-09 15:02:27 +0200
committerGustaf Rydholm <gustaf.rydholm@gmail.com>2024-08-09 15:02:27 +0200
commit782ca010fbc57025e4c69fa71085bb6997af23c5 (patch)
tree3d7f966848109e2e105d1962095cb1ccd93f166f /README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f7de57e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Mystic
+
+**TODO: Add description**
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+by adding `mystic` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+ [
+ {:mystic, "~> 0.1.0"}
+ ]
+end
+```
+
+Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
+and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
+be found at <https://hexdocs.pm/mystic>.
+