From af7d165a7f84f83a4c5d9f434a5320a5844d8ad3 Mon Sep 17 00:00:00 2001
From: Denys Dovhan <denysd96@gmail.com>
Date: Wed, 3 Oct 2018 18:59:30 +0300
Subject: node: add README (#7201)

---
 plugins/node/README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 plugins/node/README.md

(limited to 'plugins/node/README.md')

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 
+```
-- 
cgit v1.2.3-70-g09d2