69bd9ab3f040a8ad55b59cbd306aa91852184064

Author
Zach Whitten <zwhitten+github@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

mix: add README (#7185)

Diff

 1diff --git a/plugins/mix/README.md b/plugins/mix/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..63476dd6b4f0682f98f6e2b1beaf4f74d75950cb
 4--- /dev/null
 5+++ b/plugins/mix/README.md
 6@@ -0,0 +1,18 @@
 7+# Mix plugin
 8+
 9+This plugin adds completions for the [Elixir's Mix build tool](https://hexdocs.pm/mix/Mix.html).
10+
11+To use it, add `mix` to the plugins array in your zshrc file:
12+
13+```zsh
14+plugins=(... mix)
15+```
16+## Supported Task Types
17+
18+| Task Type               | Documentation                                            |
19+|-------------------------|----------------------------------------------------------|
20+| Elixir                  | [Elixir Lang](https://elixir-lang.org/)                  |
21+| Phoenix v1.2.1 and below| [Phoenix](https://hexdocs.pm/phoenix/1.2.1/Phoenix.html) |
22+| Phoenix v1.3.0 and above| [Phoenix](https://hexdocs.pm/phoenix/Phoenix.html)       |
23+| Ecto                    | [Ecto](https://hexdocs.pm/ecto/Ecto.html)                |
24+| Hex                     | [Hex](https://hex.pm/)                                   |