ea6ec09b9c7752ee0e074659ca0689d0af053e5a

Author
Erwan ROUSSEL <erwan.roussel51@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

cake: add README (#7473)

Diff

 1diff --git a/plugins/cake/README.md b/plugins/cake/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..aad92a3eccf42ca624d0f07840ca26008396bcec
 4--- /dev/null
 5+++ b/plugins/cake/README.md
 6@@ -0,0 +1,15 @@
 7+# Cake
 8+
 9+This plugin provides completion for [CakePHP](https://cakephp.org/).
10+
11+To use it add cake to the plugins array in your zshrc file.
12+
13+```bash
14+plugins=(... cake)
15+```
16+
17+## Note
18+
19+This plugin generates a cache file of the cake tasks found, named `.cake_task_cache`, in the current working directory. 
20+It is regenerated when the Cakefile is newer than the cache file. It is advised that you add the cake file to your
21+`.gitignore` files.