Browse Source

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

Sofia Rivas 5 years ago
parent
commit
767be6c42f
1 changed files with 14 additions and 0 deletions
  1. 14 0
      plugins/git-remote-branch/README.md

+ 14 - 0
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.