summaryrefslogtreecommitdiff
path: root/plugins/nvm/README.md
diff options
context:
space:
mode:
authordavidfmatheson <david.f.matheson@gmail.com>2020-10-08 11:21:34 -0400
committerGitHub <noreply@github.com>2020-10-08 17:21:34 +0200
commit27857e66d0dab0bd05790307dfe5388f3cb2c51a (patch)
tree6938101ce6aabe02a86fb4d7a52440d31ccf6c6e /plugins/nvm/README.md
parent01ce52e6814c27a61945ed4406059c14f0c5d548 (diff)
downloadzsh-27857e66d0dab0bd05790307dfe5388f3cb2c51a.tar.gz
zsh-27857e66d0dab0bd05790307dfe5388f3cb2c51a.tar.bz2
zsh-27857e66d0dab0bd05790307dfe5388f3cb2c51a.zip
nvm: add Homebrew's nvm setup (#8316)
Co-authored-by: Marc Cornellà <marc.cornella@live.com>
Diffstat (limited to 'plugins/nvm/README.md')
-rw-r--r--plugins/nvm/README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/plugins/nvm/README.md b/plugins/nvm/README.md
index 079cf0009..2515da9e8 100644
--- a/plugins/nvm/README.md
+++ b/plugins/nvm/README.md
@@ -1,9 +1,18 @@
# nvm plugin
-This plugin adds autocompletions for [nvm](https://github.com/creationix/nvm) — a Node.js version manager.
+This plugin adds autocompletions for [nvm](https://github.com/nvm-sh/nvm) — a Node.js version manager.
It also automatically sources nvm, so you don't need to do it manually in your `.zshrc`.
To use it, add `nvm` to the plugins array of your zshrc file:
+
```zsh
plugins=(... nvm)
```
+
+## Settings
+
+- **`NVM_DIR`**: if you have installed nvm in a directory other than `$HOME/.nvm`, set and export `NVM_DIR`
+ to be the directory where you installed nvm.
+
+- **`NVM_HOMEBREW`**: if you installed nvm via Homebrew, in a directory other than `/usr/local/opt/nvm`, you
+ can set `NVM_HOMEBREW` to be the directory where you installed it.