summaryrefslogtreecommitdiff
path: root/plugins/cake/README.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2019-01-31 17:25:13 -0700
committerTuowen Zhao <ztuowen@gmail.com>2019-01-31 17:25:13 -0700
commit89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095 (patch)
tree0a301691b8481163680454a1f07ca54115ec17eb /plugins/cake/README.md
parent075160b86c64045e661209ad7906559068b44104 (diff)
parent851899e59ea71ce8fbae738ec7aeb7a967585977 (diff)
downloadzsh-89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095.tar.gz
zsh-89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095.tar.bz2
zsh-89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095.zip
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/cake/README.md')
-rw-r--r--plugins/cake/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/cake/README.md b/plugins/cake/README.md
new file mode 100644
index 000000000..aad92a3ec
--- /dev/null
+++ b/plugins/cake/README.md
@@ -0,0 +1,15 @@
+# Cake
+
+This plugin provides completion for [CakePHP](https://cakephp.org/).
+
+To use it add cake to the plugins array in your zshrc file.
+
+```bash
+plugins=(... cake)
+```
+
+## Note
+
+This plugin generates a cache file of the cake tasks found, named `.cake_task_cache`, in the current working directory.
+It is regenerated when the Cakefile is newer than the cache file. It is advised that you add the cake file to your
+`.gitignore` files.