Add documentation and code-review relative diff

Author: xorkevin

README.md

@@ -2,6 +2,30 @@
 
 zsh code review plugin
 
+### Usage
+
+```
+code-review [base_branch] [target_branch]
+```
+
+- `base_branch`: (default: $REVIEW_BASE_BRANCH, master)
+- `target_branch`: (default: HEAD)
+
+Launches `git difftool` on `git merge-base target_branch base_branch` and
+`target_branch`.
+
 ### Install
 
-If using `antibody`: `antibody bundle xorkevin/code-review-zsh`
+#### Antibody
+
+```
+$ antibody bundle xorkevin/code-review-zsh
+```
+
+#### Manual
+
+In `.zshrc`:
+
+```
+source code-review.plugin.zsh
+```

code-review.plugin.zsh

@@ -5,14 +5,14 @@ function code-review () {
     return
   fi
 
-  local base_branch=${1:-${GIT_BASE_BRANCH:-master}}
+  local base_branch=${1:-${REVIEW_BASE_BRANCH:-master}}
   local target_branch=${2:-HEAD}
 
   local merge_base=$(git merge-base $target_branch $base_branch)
 
   local shortstatout=$(git diff --shortstat --color $merge_base $target_branch)
   local statout=$(git diff --stat --color $merge_base $target_branch)
-  local filesout=$(git diff --name-only $merge_base $target_branch)
+  local filesout=$(git diff --relative --name-only $merge_base $target_branch)
 
   local LESS
   local selectfile
@@ -26,6 +26,7 @@ function code-review () {
     # clear screen; move to top left
     echo -ne "\e[2J\e[H"
     echo " comparing $base_branch..$target_branch"
+    echo " from $(pwd)"
     echo $shortstatout
     echo -n " Usage: l - list changed files, f - launch difftool for file, q - quit"
     read -sk opt