summaryrefslogtreecommitdiff
path: root/plugins/bun/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/bun/README.md')
-rw-r--r--plugins/bun/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/bun/README.md b/plugins/bun/README.md
new file mode 100644
index 000000000..5a312370f
--- /dev/null
+++ b/plugins/bun/README.md
@@ -0,0 +1,20 @@
+# Bun Plugin
+
+This plugin sets up completion for [Bun](https://bun.sh).
+
+To use it, add `bun` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... bun)
+```
+
+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/_bun_` completions script