Merge pull request #2660 from KevinBongart/add-readme-to-rake-fast
Add README file to rake-fast plugin
Diff
1diff --git a/plugins/rake-fast/README.md b/plugins/rake-fast/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..f56142f6953260546a1856f7e91d8f961328fa23
4--- /dev/null
5+++ b/plugins/rake-fast/README.md
6@@ -0,0 +1,23 @@
7+# rake-fast
8+
9+Fast rake autocompletion plugin.
10+
11+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.
12+
13+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/).
14+
15+Think about that. 2006.
16+
17+## Installation
18+
19+Just add the plugin to your `.zshrc`:
20+
21+```bash
22+plugins=(foo bar rake-fast)
23+```
24+
25+You might consider adding `.rake_tasks` to your [global .gitignore](https://help.github.com/articles/ignoring-files#global-gitignore)
26+
27+## Usage
28+
29+`rake`, then press tab
30diff --git a/plugins/rake-fast/rake-fast.plugin.zsh b/plugins/rake-fast/rake-fast.plugin.zsh
31index 320855233f38a5d5e342f5cc04b85a73c3785c50..545b6c049ae89c0ad373cd777fd1efcffc625603 100644
32--- a/plugins/rake-fast/rake-fast.plugin.zsh
33+++ b/plugins/rake-fast/rake-fast.plugin.zsh
34@@ -1,20 +1,3 @@
35-# rake-fast
36-# Fast rake autocompletion plugin for oh-my-zsh
37-
38-# This script caches the output for later usage and significantly speeds it up.
39-# It generates a .rake_tasks file in parallel to the Rakefile.
40-
41-# You'll want to add `.rake_tasks` to your global .git_ignore file:
42-# https://help.github.com/articles/ignoring-files#global-gitignore
43-
44-# You can force .rake_tasks to refresh with:
45-# $ rake_refresh
46-
47-# This is entirely based on Ullrich Schäfer's work
48-# (https://github.com/robb/.dotfiles/pull/10/),
49-# which is inspired by this Ruby on Rails trick from 2006:
50-# http://weblog.rubyonrails.org/2006/3/9/fast-rake-task-completion-for-zsh/
51-
52 _rake_refresh () {
53 if [ -f .rake_tasks ]; then
54 rm .rake_tasks