0f6e3dc223942f553fa512d4d8d2d9eb3df3ab8e

Author
Denys Dovhan <denysd96@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

grunt: add README (#7198)

Diff

 1diff --git a/plugins/grunt/README.md b/plugins/grunt/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..a69a9b7fc5cf23c3c61d74bea949ec9aff99a70c
 4--- /dev/null
 5+++ b/plugins/grunt/README.md
 6@@ -0,0 +1,37 @@
 7+# grunt plugin
 8+
 9+This plugin adds completions for [grunt](https://github.com/gruntjs/grunt).
10+
11+To use it, add `grunt` to the plugins array of your `.zshrc` file:
12+```zsh
13+plugins=(... grunt)
14+```
15+
16+## Enable caching
17+
18+If you want to use the cache, set the following in your `.zshrc`:
19+```zsh
20+zstyle ':completion:*' use-cache yes
21+```
22+
23+## Settings
24+
25+* Show grunt file path:
26+  ```zsh
27+  zstyle ':completion::complete:grunt::options:' show_grunt_path yes
28+  ```
29+* Cache expiration days (default: 7):
30+  ```zsh
31+  zstyle ':completion::complete:grunt::options:' expire 1
32+  ```
33+* Not update options cache if target gruntfile is changed.
34+  ```zsh
35+  zstyle ':completion::complete:grunt::options:' no_update_options yes
36+  ```
37+
38+Note that if you change the zstyle settings, you should delete the cache file and restart zsh.
39+
40+```zsh
41+$ rm ~/.zcompcache/grunt
42+$ exec zsh
43+```