summaryrefslogtreecommitdiff
path: root/plugins/qodana/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/qodana/README.md')
-rw-r--r--plugins/qodana/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/qodana/README.md b/plugins/qodana/README.md
new file mode 100644
index 000000000..0b68bdecf
--- /dev/null
+++ b/plugins/qodana/README.md
@@ -0,0 +1,20 @@
+# JetBrains Qodana CLI plugin
+
+This plugin adds completion for the [JetBrains Qodana CLI](https://github.com/JetBrains/qodana-cli).
+
+To use it, add `qodana` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... qodana)
+```
+
+This plugin does not add any aliases.
+
+## Cache
+
+This plugin caches the completion script and is automatically updated when the
+plugin is loaded, which is usually when you start up a new terminal emulator.
+
+The cache is stored at:
+
+- `$ZSH_CACHE_DIR/completions/_qodana` completions script