59fdb2b505bc415738dc92f6188453e54bf0c45c
- Author
- Marc Cornellà <marc.cornella@live.com>
- Committer
- Marc Cornellà <marc.cornella@live.com>
- Date
Message
Diff
1diff --git a/plugins/rake-fast/README.md b/plugins/rake-fast/README.md
2index f56142f6953260546a1856f7e91d8f961328fa23..1417befa15cef23b3ca3184fbbd7e950331f38b7 100644
3--- a/plugins/rake-fast/README.md
4+++ b/plugins/rake-fast/README.md
5@@ -2,22 +2,34 @@
6
7 Fast rake autocompletion plugin.
8
9-This script caches the output for later usage and significantly speeds it up. It generates a .rake_tasks cache file in parallel to the Rakefile. It also checks the file modification dates to see if it needs to regenerate the cache file.
10+This plugin caches the output for later usage and significantly speeds it up.
11+It generates a `.rake_tasks` cache file in parallel to the Rakefile. It also
12+checks the file modification time to see if it needs to regenerate the cache
13+file.
14
15-This is entirely based on [this pull request by Ullrich Schäfer](https://github.com/robb/.dotfiles/pull/10/), which is inspired by [this Ruby on Rails trick from 2006](http://weblog.rubyonrails.org/2006/3/9/fast-rake-task-completion-for-zsh/).
16+This is entirely based on [this pull request by Ullrich Schäfer](https://github.com/robb/.dotfiles/pull/10/),
17+which is inspired by [this Ruby on Rails trick from 2006](http://weblog.rubyonrails.org/2006/3/9/fast-rake-task-completion-for-zsh/).
18
19 Think about that. 2006.
20
21+----------
22+
23+Since August of 2016, it also checks if it's in a Rails project and looks at
24+rake files inside `lib/tasks` and their modification time to know if the
25+cache file needs to be regenerated.
26+
27 ## Installation
28
29 Just add the plugin to your `.zshrc`:
30
31-```bash
32-plugins=(foo bar rake-fast)
33+```zsh
34+plugins=(... rake-fast)
35 ```
36
37 You might consider adding `.rake_tasks` to your [global .gitignore](https://help.github.com/articles/ignoring-files#global-gitignore)
38
39 ## Usage
40
41-`rake`, then press tab
42+Type `rake`, then press tab.
43+
44+If you want to force the regeneration of the `.rake_tasks` file, run `rake_refresh`.