From 62377ab6cbd703b4750c6270daa94bff870e1692 Mon Sep 17 00:00:00 2001 From: Rafael Antonio Lucio Date: Sun, 10 Dec 2017 00:14:49 -0200 Subject: [PATCH] Add file to description how to use zsh_nvm_auto_load --- plugins/nvm/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 plugins/nvm/README.md diff --git a/plugins/nvm/README.md b/plugins/nvm/README.md new file mode 100644 index 000000000..d15cac9de --- /dev/null +++ b/plugins/nvm/README.md @@ -0,0 +1,15 @@ +# NVM plugin + +## Description + +This plugin provides load nvm if it exists and when the .nvmrc file exists in your directory, it will download the described node version. + +To start using it: + * Add the `ZSH_NVM_AUTOLOAD=true` at the beginning of the file `~/.zshrc` + * Add `nvm` plugin to your plugins array in `~/.zshrc` + +```zsh +ZSH_NVM_AUTOLOAD=true +# ... +plugins=(... nvm) +``` \ No newline at end of file