summaryrefslogtreecommitdiff
path: root/plugins/nats/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/nats/README.md')
-rw-r--r--plugins/nats/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/plugins/nats/README.md b/plugins/nats/README.md
new file mode 100644
index 000000000..0ea26fca1
--- /dev/null
+++ b/plugins/nats/README.md
@@ -0,0 +1,14 @@
+# NATS plugin
+
+This plugin adds completion for several tools from [NATS](https://nats.io/).
+
+- [`nsc`](https://github.com/nats-io/nsc)
+- [`natscli`](https://github.com/nats-io/natscli)
+
+To use it, add `nats` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... nats)
+```
+
+This plugin does not add any aliases.