From 2214494881ad04d363357429e5b893243ed2b285 Mon Sep 17 00:00:00 2001 From: Matt Hamilton Date: Mon, 5 Sep 2016 15:36:44 -0700 Subject: [PATCH] [Readme] add update and removal notes Closes #50 --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index c2bb376..f3fe683 100644 --- a/README.md +++ b/README.md @@ -67,8 +67,38 @@ Installing Zim is easy. If you have a different shell framework installed (like 5. You're done! Enjoy your Zsh IMproved! Take some time to read about the [available modules][modules] and tweak your `.zshrc` file. +Updating +-------- + +To update zim, run: + +``` +zmanage update +``` + +For more information about the `zmanage` tool, see the [meta module][meta-module] documentation. + +Uninstalling +------------ + +The best way to remove zim is to manually delete `~/.zim`, `~/.zimrc`, and +remove the initialization lines from your `~/.zshrc`. + +However, there are some **experimental** convenience functions to remove zim: + +**NOTE: This functionality is experimental!** + +To remove zim, run: +``` +zmanage remove +``` + +**NOTE: This functionality is experimental!** + + [fish_shell]: https://i.eriner.me/zim_history-substring-search.gif [syntax_highlighting]: https://i.eriner.me/zim_syntax-highlighting.gif [speed]: https://github.com/Eriner/zim/wiki/Speed [modules]: https://github.com/Eriner/zim/wiki/Modules [themes]: https://github.com/Eriner/zim/wiki/Themes +[meta-module]: https://github.com/Eriner/zim/tree/master/modules/meta