af7d165a7f84f83a4c5d9f434a5320a5844d8ad3
- Author
- Denys Dovhan <denysd96@gmail.com>
- Committer
- Marc Cornellà <marc.cornella@live.com>
- Date
Message
node: add README (#7201)
Diff
1diff --git a/plugins/node/README.md b/plugins/node/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..c392dc0bfb0361ea064cda4d77160bfc556a4ee4
4--- /dev/null
5+++ b/plugins/node/README.md
6@@ -0,0 +1,16 @@
7+# node plugin
8+
9+To use it, add `node` to the plugins array of your zshrc file:
10+```zsh
11+plugins=(... node)
12+```
13+
14+This plugin adds `node-docs` function that open specific section in [Node.js](https://nodejs.org) documentation (depending on the installed version).
15+For example:
16+
17+```zsh
18+# Opens https://nodejs.org/docs/latest-v10.x/api/fs.html
19+$ node-docs fs
20+# Opens https://nodejs.org/docs/latest-v10.x/api/path.html
21+$ node-docs path
22+```