diff options
Diffstat (limited to 'plugins/node/README.md')
| -rw-r--r-- | plugins/node/README.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/plugins/node/README.md b/plugins/node/README.md index c392dc0bf..911b6693b 100644 --- a/plugins/node/README.md +++ b/plugins/node/README.md @@ -1,16 +1,19 @@ # node plugin +This plugin adds `node-docs` function that opens specific section in [Node.js](https://nodejs.org) +documentation (depending on the installed version). + To use it, add `node` to the plugins array of your zshrc file: + ```zsh plugins=(... node) ``` -This plugin adds `node-docs` function that open specific section in [Node.js](https://nodejs.org) documentation (depending on the installed version). -For example: +## Usage ```zsh # Opens https://nodejs.org/docs/latest-v10.x/api/fs.html $ node-docs fs # Opens https://nodejs.org/docs/latest-v10.x/api/path.html -$ node-docs path +$ node-docs path ``` |