summaryrefslogtreecommitdiff
path: root/plugins/git-remote-branch
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/git-remote-branch')
-rw-r--r--plugins/git-remote-branch/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/plugins/git-remote-branch/README.md b/plugins/git-remote-branch/README.md
new file mode 100644
index 000000000..bd73e5dec
--- /dev/null
+++ b/plugins/git-remote-branch/README.md
@@ -0,0 +1,14 @@
+# git-remote-branch plugin
+
+This plugin adds completion for [`grb`](https://github.com/webmat/git_remote_branch),
+or `git_remote_branch`.
+
+To use it, add `git-remote-branch` to the plugins array of your `.zshrc` file:
+```
+plugins=(... git-remote-branch)
+```
+
+## Deprecation
+
+[git_remote_branch was archived in 2018](https://github.com/webmat/git_remote_branch#archived),
+meaning it's not actively maintained anymore. Use at your own risk.