浏览代码

arcanist: document aliases

Marc Cornellà 4 年之前
父节点
当前提交
1381da15a4
共有 1 个文件被更改,包括 26 次插入2 次删除
  1. 26 2
      plugins/arcanist/README.md

+ 26 - 2
plugins/arcanist/README.md

@@ -1,5 +1,29 @@
 ## arcanist
 
-**Maintainer:** [@emzar](https://github.com/emzar)
-
 This plugin adds many useful aliases for [arcanist](https://github.com/phacility/arcanist).
+
+To use it, add `arcanist` to the plugins array of your zshrc file:
+
+```zsh
+plugins=(... arcanist)
+```
+
+## Aliases
+
+| Alias   | Command                            |
+|---------|------------------------------------|
+| ara     | `arc amend`                        |
+| arb     | `arc branch`                       |
+| arco    | `arc cover`                        |
+| arci    | `arc commit`                       |
+| ard     | `arc diff`                         |
+| ardc    | `arc diff --create`                |
+| ardnu   | `arc diff --nounit`                |
+| ardnupc | `arc diff --nounit --plan-changes` |
+| ardpc   | `arc diff --plan-changes`          |
+| are     | `arc export`                       |
+| arh     | `arc help`                         |
+| arl     | `arc land`                         |
+| arli    | `arc lint`                         |
+| arls    | `arc list`                         |
+| arpa    | `arc patch`                        |