Skip to content

Commit

Permalink
Merge pull request github-tools#189 from stevedesmond-ca/patch-1
Browse files Browse the repository at this point in the history
add documentation for listPulls and getPull in README.md
  • Loading branch information
Ændrew Rininsland committed May 29, 2015
2 parents 3c5dd96 + f2f2c03 commit ce89e78
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,20 @@ Create new branch for repo. You can omit oldBranchName to default to "master".
repo.branch(oldBranchName, newBranchName, function(err) {});
```

List Pull Requests.

```js
var state = 'open'; //or 'closed', or 'all'
repo.listPulls(state, function(err, pullRequests) {});
```

Get details of a Pull Request.

```js
var pullRequestID = 123;
repo.getPull(pullRequestID, function(err, pullRequestInfo) {});
```

Create Pull Request.

```js
Expand All @@ -103,7 +117,6 @@ var pull = {
repo.createPullRequest(pull, function(err, pullRequest) {});
```


Retrieve all available branches (aka heads) of a repository.

```js
Expand Down

0 comments on commit ce89e78

Please sign in to comment.