From 70ab2928a5ecd2513d4f6a67beb10f79d64d5172 Mon Sep 17 00:00:00 2001
From: "kalle (jag)" <kalle.jillheden@gmail.com>
Date: Mon, 3 May 2021 16:35:28 +0200
Subject: feat(plugins): add `gh` plugin for GitHub CLI (#9557)

---
 plugins/gh/README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 plugins/gh/README.md

(limited to 'plugins/gh/README.md')

diff --git a/plugins/gh/README.md b/plugins/gh/README.md
new file mode 100644
index 000000000..54e046a1c
--- /dev/null
+++ b/plugins/gh/README.md
@@ -0,0 +1,23 @@
+# GitHub CLI plugin
+
+This plugin adds completion for the [GitHub CLI](https://cli.github.com/).
+
+To use it, add `gh` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... gh)
+```
+
+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/plugins/gh/_gh` completions script
+
+- `$ZSH_CACHE_DIR/gh_version` version of GitHub CLI, used to invalidate
+  the cache.
-- 
cgit v1.2.3-70-g09d2