Skip to content

Commit

Permalink
Added description of repo.current_commit and how to get unlimited com…
Browse files Browse the repository at this point in the history
…mits by repo.commits to README.md
  • Loading branch information
Igor Muzyka committed Feb 20, 2014
1 parent 77f0b30 commit 4c1fee0
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,23 @@ Or to a different tag or branch.

repo.commits "v0.0.3", (err, commits) ->

Limit the maximum number of commits returned.
Limit the maximum number of commits returned (by default limit is 10).

repo.commits "master", 30, (err, commits) ->

Skip some (for pagination):

repo.commits "master", 30, 30, (err, commits) ->

To get unlimited amount of commits:

repo.commits "master", -1, (err, commits) ->

### `Repo#current_commit(callback)`
Get current commit

The callback receives `(err, commit)`.

### `Repo#tree([treeish]) => Tree`
The `Tree` object for the treeish (which defaults to "master").

Expand Down

0 comments on commit 4c1fee0

Please sign in to comment.