summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/node/README.md
diff options
context:
space:
mode:
authorAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
committerAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
commitedc449275b6c04445f58b108ca0937a87c1e8430 (patch)
tree9fd484d58145b616f29a78857cc0b1c8b1c18f05 /oh-my-zsh/plugins/node/README.md
parent6f5424ca96c4221ef433f545642669e9c104d0ed (diff)
add zsh
Diffstat (limited to 'oh-my-zsh/plugins/node/README.md')
-rw-r--r--oh-my-zsh/plugins/node/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/node/README.md b/oh-my-zsh/plugins/node/README.md
new file mode 100644
index 0000000..911b669
--- /dev/null
+++ b/oh-my-zsh/plugins/node/README.md
@@ -0,0 +1,19 @@
+# node plugin
+
+This plugin adds `node-docs` function that opens specific section in [Node.js](https://nodejs.org)
+documentation (depending on the installed version).
+
+To use it, add `node` to the plugins array of your zshrc file:
+
+```zsh
+plugins=(... node)
+```
+
+## Usage
+
+```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
+```