summaryrefslogtreecommitdiff
path: root/plugins/mongo-atlas/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/mongo-atlas/README.md')
-rw-r--r--plugins/mongo-atlas/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/plugins/mongo-atlas/README.md b/plugins/mongo-atlas/README.md
new file mode 100644
index 000000000..ef1b5e0d2
--- /dev/null
+++ b/plugins/mongo-atlas/README.md
@@ -0,0 +1,10 @@
+# MongoDB Atlas plugin
+
+This plugin adds completion for [Atlas](https://www.mongodb.com/docs/atlas/cli/stable/) a command line interface built specifically for
+MongoDB Atlas.
+
+To use it, add `mongo-atlas` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... mongo-atlas)
+```