summaryrefslogtreecommitdiff
path: root/plugins/zsh_reload/README.md
diff options
context:
space:
mode:
authorMonson Shao <holymonson@gmail.com>2020-07-03 12:16:58 +0800
committerMarc Cornellà <hello@mcornella.com>2021-10-04 16:24:05 +0200
commitbe4a952972de03d501fbff79435ae41594f06bac (patch)
tree7c4889006414d4d26433284c7d0f07b8971dede0 /plugins/zsh_reload/README.md
parent56ab66b19429e5609e4331a987368ce2c844c7be (diff)
downloadzsh-be4a952972de03d501fbff79435ae41594f06bac.tar.gz
zsh-be4a952972de03d501fbff79435ae41594f06bac.tar.bz2
zsh-be4a952972de03d501fbff79435ae41594f06bac.zip
feat(cli)!: add `omz reload` command and deprecate `zsh_reload` plugin (#9078)
BREAKING CHANGE: the `zsh_reload` plugin is deprecated. Instead of using its `src` function, use `omz reload` or `exec zsh` to reload zsh after making changes to your `.zshrc` file. Closes #9078
Diffstat (limited to 'plugins/zsh_reload/README.md')
-rw-r--r--plugins/zsh_reload/README.md22
1 files changed, 1 insertions, 21 deletions
diff --git a/plugins/zsh_reload/README.md b/plugins/zsh_reload/README.md
index d31a827fe..0b2e2a775 100644
--- a/plugins/zsh_reload/README.md
+++ b/plugins/zsh_reload/README.md
@@ -1,23 +1,3 @@
# 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!
-```
+**This plugin is deprecated.** Use `omz reload` or `exec zsh` instead.