summaryrefslogtreecommitdiff
path: root/plugins/zsh_reload/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/zsh_reload/README.md')
-rw-r--r--plugins/zsh_reload/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/plugins/zsh_reload/README.md b/plugins/zsh_reload/README.md
new file mode 100644
index 000000000..d31a827fe
--- /dev/null
+++ b/plugins/zsh_reload/README.md
@@ -0,0 +1,23 @@
+# zsh_reload plugin
+
+The zsh_reload plugin defines a function to reload the zsh session with
+just a few keystrokes.
+
+To use it, add `zsh_reload` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... zsh_reload)
+```
+
+## Usage
+
+To reload the zsh session, just run `src`:
+
+```zsh
+$ vim ~/.zshrc # enabled a plugin
+$ src
+re-compiling /home/user/.zshrc.zwc: succeeded
+re-compiling /home/user/.oh-my-zsh/cache/zcomp-host.zwc: succeeded
+
+# you now have a fresh zsh session. happy hacking!
+```