summaryrefslogtreecommitdiff
path: root/plugins/repo/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/repo/README.md')
-rw-r--r--plugins/repo/README.md28
1 files changed, 23 insertions, 5 deletions
diff --git a/plugins/repo/README.md b/plugins/repo/README.md
index 4d9366adf..6abd23319 100644
--- a/plugins/repo/README.md
+++ b/plugins/repo/README.md
@@ -1,7 +1,25 @@
-## repo
-**Maintainer:** [Stibbons](https://github.com/Stibbons)
+# repo plugin
-This plugin mainly add support automatic completion for the repo command line tool:
-https://code.google.com/p/git-repo/
+This plugin mainly adds some aliases and support for automatic completion for
+the [repo command line tool](https://code.google.com/p/git-repo/).
-* `r` aliases `repo`
+To use it, add `repo` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... repo)
+```
+
+## Aliases
+
+| Alias | Command |
+|---------|----------------------------------------|
+| `r` | `repo` |
+| `rra` | `repo rebase --auto-stash` |
+| `rs` | `repo sync` |
+| `rsrra` | `repo sync ; repo rebase --auto-stash` |
+| `ru` | `repo upload` |
+| `rst` | `repo status` |
+| `rsto` | `repo status -o` |
+| `rfa` | `repo forall -c` |
+| `rfap` | `repo forall -p -c` |
+| `rinf` | `repo info` |