summaryrefslogtreecommitdiff
path: root/plugins/npx/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/npx/README.md')
-rw-r--r--plugins/npx/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/plugins/npx/README.md b/plugins/npx/README.md
new file mode 100644
index 000000000..2c94e4515
--- /dev/null
+++ b/plugins/npx/README.md
@@ -0,0 +1,17 @@
+# NPX Plugin
+> npx(1) -- execute npm package binaries. ([more info](https://github.com/zkat/npx))
+
+This plugin automatically registers npx command-not-found handler if `npx` exists in your `$PATH`.
+
+## Setup
+
+- Add plugin to `~/.zshrc`
+
+```bash
+plugins=(.... npx)
+```
+
+- Globally install npx binary (you need node.js installed too!)
+```bash
+sudo npm install -g npx
+``` \ No newline at end of file