diff options
| author | Carlos Eduardo Monti <slaytanic@gmail.com> | 2023-02-27 20:22:39 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-27 20:22:39 +0100 |
| commit | 21bdb18b2d1fe8b547a42da7ac7b58fb28563a2c (patch) | |
| tree | cadbf38f6aff3450b36e41f14ab4a9e9cdadd31a /plugins/nodenv/README.md | |
| parent | 16050ab80e63f8e53c07777b4c2ae16ad085e5ad (diff) | |
| download | zsh-21bdb18b2d1fe8b547a42da7ac7b58fb28563a2c.tar.gz zsh-21bdb18b2d1fe8b547a42da7ac7b58fb28563a2c.tar.bz2 zsh-21bdb18b2d1fe8b547a42da7ac7b58fb28563a2c.zip | |
feat(nodenv): add plugin for `nodenv` (#9880)
Co-authored-by: Matthew Boston <matthew@matthewboston.com>
Diffstat (limited to 'plugins/nodenv/README.md')
| -rw-r--r-- | plugins/nodenv/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/nodenv/README.md b/plugins/nodenv/README.md new file mode 100644 index 000000000..550597025 --- /dev/null +++ b/plugins/nodenv/README.md @@ -0,0 +1,20 @@ +# nodenv plugin + +The primary job of this plugin is to provide `nodenv_prompt_info` which can be added to your theme to include Node +version information into your prompt. + +To use it, add `nodenv` to the plugins array in your zshrc file: + +```zsh +plugins=(... nodenv) +``` + +## Functions + +* `nodenv_prompt_info`: displays the Node version in use by nodenv; or the global Node + version, if nodenv wasn't found. You can use this function in your prompt by adding + `$(nodenv_prompt_info)` to PROMPT or RPROMPT: + + ```zsh + RPROMPT='$(nodenv_prompt_info)' + ``` |