summaryrefslogtreecommitdiff
path: root/plugins/ngrok/README.md
diff options
context:
space:
mode:
authorJonathan Stacks <jonstacks@users.noreply.github.com>2024-11-28 00:57:21 -0800
committerGitHub <noreply@github.com>2024-11-28 09:57:21 +0100
commit69a6359f7cf8978d464573fb7b023ee3cd00181a (patch)
treee5b3a6d1d3058b1b7b61c67c2b20145b79083203 /plugins/ngrok/README.md
parent366d25435229bfa725109a147d6cb2fef8011b3c (diff)
downloadzsh-69a6359f7cf8978d464573fb7b023ee3cd00181a.tar.gz
zsh-69a6359f7cf8978d464573fb7b023ee3cd00181a.tar.bz2
zsh-69a6359f7cf8978d464573fb7b023ee3cd00181a.zip
feat(ngrok): add completion plugin (#12826)
Diffstat (limited to 'plugins/ngrok/README.md')
-rw-r--r--plugins/ngrok/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/ngrok/README.md b/plugins/ngrok/README.md
new file mode 100644
index 000000000..6c37b1905
--- /dev/null
+++ b/plugins/ngrok/README.md
@@ -0,0 +1,20 @@
+# ngrok plugin
+
+This plugin adds completion for the [ngrok](https://ngrok.com) CLI.
+
+To use it, add `ngrok` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... ngrok)
+```
+
+This plugin does not add any aliases.
+
+## Cache
+
+This plugin caches the completion script and is automatically updated asynchronously when the plugin is
+loaded, which is usually when you start up a new terminal emulator.
+
+The cache is stored at:
+
+- `$ZSH_CACHE/completions/_ngrok` completions script