Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nlf committed Oct 13, 2012
1 parent 1ee1c48 commit 89b7f8e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -13,7 +13,9 @@ function myMiddleware(pull_request, comments, next) { }
```

The pull_request object contains all the metadata github returns for a pull request as defined [here](http://developer.github.com/v3/pulls/#get-a-single-pull-request)

Comments is an array of comments on that pull request as defined [here](http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue)

Next is the callback function you should run when your check is complete. If you return no parameter, GitEnforcer will continue execution on the next middleware. If you specify a paramater (as a string) then execution of middleware stops, and that string is set as the reason for failure on the pull request's status.

Usage
Expand Down

0 comments on commit 89b7f8e

Please sign in to comment.