summaryrefslogtreecommitdiff
path: root/plugins/cask/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/cask/README.md')
-rw-r--r--plugins/cask/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/cask/README.md b/plugins/cask/README.md
new file mode 100644
index 000000000..e1335c1b8
--- /dev/null
+++ b/plugins/cask/README.md
@@ -0,0 +1,15 @@
+# Cask plugin
+
+[Cask](https://github.com/cask/cask) is a project management tool for Emacs that helps
+automate the package development cycle; development, dependencies, testing, building,
+packaging and more.
+
+This plugin loads `cask` completion from non-standard locations, such as if installed
+via Homebrew or others. To enable it, add `cask` to your plugins array:
+
+```zsh
+plugins=(... cask)
+```
+
+Make sure you have the `cask` directory in your `$PATH` before loading Oh My Zsh,
+otherwise you'll get a "command not found" error.