summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorZach Whitten <zwhitten+github@gmail.com>2018-10-02 13:58:14 -0400
committerMarc Cornellà <marc.cornella@live.com>2018-10-02 19:58:14 +0200
commit69bd9ab3f040a8ad55b59cbd306aa91852184064 (patch)
tree065fe00cefe5015b5f43b02ebf5b868620915d96 /plugins
parent8bc9f23b7cb85108754ea402a02d7ebf0041175f (diff)
downloadzsh-69bd9ab3f040a8ad55b59cbd306aa91852184064.tar.gz
zsh-69bd9ab3f040a8ad55b59cbd306aa91852184064.tar.bz2
zsh-69bd9ab3f040a8ad55b59cbd306aa91852184064.zip
mix: add README (#7185)
Diffstat (limited to 'plugins')
-rw-r--r--plugins/mix/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/plugins/mix/README.md b/plugins/mix/README.md
new file mode 100644
index 000000000..63476dd6b
--- /dev/null
+++ b/plugins/mix/README.md
@@ -0,0 +1,18 @@
+# Mix plugin
+
+This plugin adds completions for the [Elixir's Mix build tool](https://hexdocs.pm/mix/Mix.html).
+
+To use it, add `mix` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... mix)
+```
+## Supported Task Types
+
+| Task Type | Documentation |
+|-------------------------|----------------------------------------------------------|
+| Elixir | [Elixir Lang](https://elixir-lang.org/) |
+| Phoenix v1.2.1 and below| [Phoenix](https://hexdocs.pm/phoenix/1.2.1/Phoenix.html) |
+| Phoenix v1.3.0 and above| [Phoenix](https://hexdocs.pm/phoenix/Phoenix.html) |
+| Ecto | [Ecto](https://hexdocs.pm/ecto/Ecto.html) |
+| Hex | [Hex](https://hex.pm/) |