fbbe902c38549dae8c8e997daeebcc797103ab7c

Author
Marc Cornellà <marc.cornella@live.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

zsh_reload: add README

Diff

 1diff --git a/plugins/zsh_reload/README.md b/plugins/zsh_reload/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..d31a827fe8a31b64499d524036965f2d9f3a08f6
 4--- /dev/null
 5+++ b/plugins/zsh_reload/README.md
 6@@ -0,0 +1,23 @@
 7+# zsh_reload plugin
 8+
 9+The zsh_reload plugin defines a function to reload the zsh session with
10+just a few keystrokes.
11+
12+To use it, add `zsh_reload` to the plugins array in your zshrc file:
13+
14+```zsh
15+plugins=(... zsh_reload)
16+```
17+
18+## Usage
19+
20+To reload the zsh session, just run `src`:
21+
22+```zsh
23+$ vim ~/.zshrc  # enabled a plugin
24+$ src
25+re-compiling /home/user/.zshrc.zwc: succeeded
26+re-compiling /home/user/.oh-my-zsh/cache/zcomp-host.zwc: succeeded
27+
28+# you now have a fresh zsh session. happy hacking!
29+```