summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2016-12-18 05:02:08 +0100
committerGitHub <noreply@github.com>2016-12-18 05:02:08 +0100
commit97c03841691021f916c46b2fd2d089d7970400aa (patch)
tree6e5a8ab609dacb52ea9041cf10081fdaacbbfe7a
parent5fa674456a7d21b489a5cb3dea2ff01e1378b2f6 (diff)
downloadzsh-97c03841691021f916c46b2fd2d089d7970400aa.tar.gz
zsh-97c03841691021f916c46b2fd2d089d7970400aa.tar.bz2
zsh-97c03841691021f916c46b2fd2d089d7970400aa.zip
Add more information to cask plugin README
-rw-r--r--plugins/cask/README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/plugins/cask/README.md b/plugins/cask/README.md
index 6457fd858..e1335c1b8 100644
--- a/plugins/cask/README.md
+++ b/plugins/cask/README.md
@@ -1,11 +1,15 @@
-# cask plugin
+# Cask plugin
-Loads `cask` completion from non-standard locations, such as if installed
+[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 the "command not found" error.
+Make sure you have the `cask` directory in your `$PATH` before loading Oh My Zsh,
+otherwise you'll get a "command not found" error.