767be6c42f1b71fe497c46faa67c2ef4e70ab829

Author
Sofia Rivas <sofi.rivasm@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

git-remote-branch: add README (#8259)

Diff

 1diff --git a/plugins/git-remote-branch/README.md b/plugins/git-remote-branch/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..bd73e5dec0b58944490727ac3f53b669663053e8
 4--- /dev/null
 5+++ b/plugins/git-remote-branch/README.md
 6@@ -0,0 +1,14 @@
 7+# git-remote-branch plugin
 8+
 9+This plugin adds completion for [`grb`](https://github.com/webmat/git_remote_branch),
10+or `git_remote_branch`.
11+
12+To use it, add `git-remote-branch` to the plugins array of your `.zshrc` file:
13+```
14+plugins=(... git-remote-branch)
15+```
16+
17+## Deprecation
18+
19+[git_remote_branch was archived in 2018](https://github.com/webmat/git_remote_branch#archived),
20+meaning it's not actively maintained anymore. Use at your own risk.