Merge pull request #38 from NoRedInk/blurb

mention --head-commit in readme

Author: michaelglass

README.md

@@ -76,6 +76,20 @@ And then execute the pr-checklist runner inside of CI using:
 bundle exec pr-checklist.rb -b branch -c tools/deploy_complexity/checklists.rb
 ```
 
+#### Overriding `HEAD`
+
+deploy-checklist will, by default, treat current `HEAD` as the `HEAD` commit for change tracking.
+
+It's possible to override that behavior like:
+
+```
+bundle exec pr-checklist.rb -b branch -c tools/deploy_complexity/checklists.rb --head-commit fafafafa
+```
+
+Where `fafafafa` would be used as the `HEAD`.
+
+This is useful if you run deploy-complexity after merging `master`. Without setting HEAD to the head of the PR pre-merge, the checklists would report on all incoming changes that are completely unrelated to the branch under analysis.
+
 ### Github Token
 
 pr-checklist.rb requires a github token with role REPO to edit PR descriptions and comment on a PR. Make sure that `GITHUB_TOKEN` is set in the environment.