1f8989aee81740760fd4202172c90446d1c391d9

Author
Kenny Heaton <kennyheaton@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

rake: add README (#8254)

Diff

 1diff --git a/plugins/rake/README.md b/plugins/rake/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..e235bd91a2c53179e54e13aeb4ef6da0c1a0b2fd
 4--- /dev/null
 5+++ b/plugins/rake/README.md
 6@@ -0,0 +1,37 @@
 7+# Rake plugin
 8+
 9+This plugin adds support for [rake](https://ruby.github.io/rake/), the Ruby
10+build tool or Ruby Make.
11+
12+To use it, add `rake` to the plugins array in your zshrc file:
13+
14+```zsh
15+plugins=(... rake)
16+```
17+
18+## Aliases
19+
20+The plugin aliases the rake command so you can pass arguments when invoking rake tasks
21+without having to escape the brackets, i.e., you can run
22+```
23+rake namespace:task['argument']
24+```
25+instead of having to do
26+```
27+rake namespace:task\['argument'\]
28+```
29+
30+| Alias  | Command                        | Description                                   |
31+|--------|--------------------------------|-----------------------------------------------|
32+| rake   | `noglob rake`                  | Allows unescaped square brackets              |
33+| brake  | `noglob bundle exec rake`      | Same as above but call rake using bundler     |
34+| srake  | `noglob sudo rake`             | Same as rake but using sudo                   |
35+| sbrake | `noglob sudo bundle exec rake` | Same as above but using both sudo and bundler |
36+
37+## Jim Weirich
38+
39+The plugin also aliases `rake` to [`jimweirich`](https://github.com/jimweirich), author of Rake
40+and big time contributor to the Ruby open source community. He passed away in 2014:
41+
42+> Thank you Jim for everything you contributed to the Ruby and open source community 
43+> over the years. We will miss you dearly. — [**@robbyrussell**](https://github.com/robbyrussell/oh-my-zsh/commit/598a9c6f990756386517d66b6bcf77e53791e905)