node: add README (#7201)

This commit is contained in:
Denys Dovhan 2018-10-03 18:59:30 +03:00 committed by Marc Cornellà
parent 9b19ca2871
commit af7d165a7f

16
plugins/node/README.md Normal file
View File

@ -0,0 +1,16 @@
# node plugin
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:
```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
```