Browse Source

Merge pull request #2660 from KevinBongart/add-readme-to-rake-fast

Add README file to rake-fast plugin
Robby Russell 11 years ago
parent
commit
a5f6f72b66
2 changed files with 23 additions and 17 deletions
  1. 23 0
      plugins/rake-fast/README.md
  2. 0 17
      plugins/rake-fast/rake-fast.plugin.zsh

+ 23 - 0
plugins/rake-fast/README.md

@@ -0,0 +1,23 @@
+# rake-fast
+
+Fast rake autocompletion plugin.
+
+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.
+
+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/).
+
+Think about that. 2006.
+
+## Installation
+
+Just add the plugin to your `.zshrc`:
+
+```bash
+plugins=(foo bar rake-fast)
+```
+
+You might consider adding `.rake_tasks` to your [global .gitignore](https://help.github.com/articles/ignoring-files#global-gitignore)
+
+## Usage
+
+`rake`, then press tab

+ 0 - 17
plugins/rake-fast/rake-fast.plugin.zsh

@@ -1,20 +1,3 @@
-# rake-fast
-# Fast rake autocompletion plugin for oh-my-zsh
-
-# This script caches the output for later usage and significantly speeds it up.
-# It generates a .rake_tasks file in parallel to the Rakefile.
-
-# You'll want to add `.rake_tasks` to your global .git_ignore file:
-# https://help.github.com/articles/ignoring-files#global-gitignore
-
-# You can force .rake_tasks to refresh with:
-# $ rake_refresh
-
-# This is entirely based on Ullrich Schäfer's work
-# (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/
-
 _rake_refresh () {
   if [ -f .rake_tasks ]; then
     rm .rake_tasks