summaryrefslogtreecommitdiff
path: root/plugins/nvm/README.md
diff options
context:
space:
mode:
authorDanny Grove <groved@google.com>2017-01-13 17:15:12 -0800
committerMarc Cornellà <marc.cornella@live.com>2020-10-09 17:21:03 +0200
commit8c8fe2a1715df916f0b5d785fee32c8a4a40c05b (patch)
treedaca8957ac1439c6913a5eeff0871a85815c3fab /plugins/nvm/README.md
parent8163f65084b86d5e63c1867d076ecdc8faca2f33 (diff)
downloadzsh-8c8fe2a1715df916f0b5d785fee32c8a4a40c05b.tar.gz
zsh-8c8fe2a1715df916f0b5d785fee32c8a4a40c05b.tar.bz2
zsh-8c8fe2a1715df916f0b5d785fee32c8a4a40c05b.zip
nvm: add autoloading of nvm version in .nvmrc
Closes #5782 Fixes #8959 Closes #8976
Diffstat (limited to 'plugins/nvm/README.md')
-rw-r--r--plugins/nvm/README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/plugins/nvm/README.md b/plugins/nvm/README.md
index ab71185cb..749a43403 100644
--- a/plugins/nvm/README.md
+++ b/plugins/nvm/README.md
@@ -20,3 +20,7 @@ plugins=(... nvm)
- **`NVM_LAZY`**: if you want the plugin to defer the load of nvm to speed-up the start of your zsh session,
set `NVM_LAZY` to `1`. This will use the `--no-use` parameter when loading nvm, and will create a function
for `node`, `npm` and `yarn`, so when you call either of these three, nvm will load with `nvm use default`.
+
+- **`NVM_AUTOLOAD`**: if `NVM_AUTOLOAD` is set to `1`, the plugin will automatically load a node version when
+ if finds a [`.nvmrc` file](https://github.com/nvm-sh/nvm#nvmrc) in the current working directory indicating
+ which node version to load.