Browse Source

node: add README (#7201)

Denys Dovhan 6 years ago
parent
commit
af7d165a7f
1 changed files with 16 additions and 0 deletions
  1. 16 0
      plugins/node/README.md

+ 16 - 0
plugins/node/README.md

@@ -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 
+```