summaryrefslogtreecommitdiff
path: root/plugins/node/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-10-24 17:57:01 +0200
committerGitHub <noreply@github.com>2019-10-24 17:57:01 +0200
commitcad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9 (patch)
tree2b07ec259bbd2b1a4919245669900a87fa87a03b /plugins/node/README.md
parent225425fe091ca052997833279ccc08643818c24a (diff)
parent40df67bc3b9b51caa24df5d220487043040d1f9a (diff)
downloadzsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.gz
zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.bz2
zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.zip
Merge branch 'master' into fabric_task_description
Diffstat (limited to 'plugins/node/README.md')
-rw-r--r--plugins/node/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/plugins/node/README.md b/plugins/node/README.md
new file mode 100644
index 000000000..c392dc0bf
--- /dev/null
+++ b/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
+```