summaryrefslogtreecommitdiff
path: root/plugins/qodana/README.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2023-11-04 18:38:46 -0700
committerTuowen Zhao <ztuowen@gmail.com>2023-11-04 18:38:46 -0700
commit4d908094fdc2a0c0e9a0a072eba213fab7adef43 (patch)
tree7c17e70bcdeebbe96c84d849bdf17882007480d8 /plugins/qodana/README.md
parent4b0bbc0b263a150eb9a9b59f196914629be06a9b (diff)
parent632ed413a9ce62747ded83d7736491b081be4b49 (diff)
downloadzsh-4d908094fdc2a0c0e9a0a072eba213fab7adef43.tar.gz
zsh-4d908094fdc2a0c0e9a0a072eba213fab7adef43.tar.bz2
zsh-4d908094fdc2a0c0e9a0a072eba213fab7adef43.zip
Merge remote-tracking branch 'github/master'HEADmaster
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