summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEvadne Wu <ev@radi.ws>2019-07-03 21:18:28 +0100
committerJames Every <devstopfix@gmail.com>2019-07-03 21:18:28 +0100
commit46375802f5c69b407140aab51854943e1c8e363c (patch)
treef0aa7c89fcad13ba423604c914ab7c1aa3a528e3 /README.md
Prototype using erlexec
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..9a4cf4d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# GenMagic
+
+**TODO: Add description**
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+by adding `gen_magic` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+ [
+ {:gen_magic, "~> 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/gen_magic](https://hexdocs.pm/gen_magic).
+