From 69bd9ab3f040a8ad55b59cbd306aa91852184064 Mon Sep 17 00:00:00 2001 From: Zach Whitten Date: Tue, 2 Oct 2018 13:58:14 -0400 Subject: [PATCH] mix: add README (#7185) --- plugins/mix/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 plugins/mix/README.md 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/) |