浏览代码

cake: add README (#7473)

Erwan ROUSSEL 5 年之前
父节点
当前提交
ea6ec09b9c
共有 1 个文件被更改,包括 15 次插入0 次删除
  1. 15 0
      plugins/cake/README.md

+ 15 - 0
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.