Skip to content

Commit

Permalink
Add Repo#reset & Repo#checkoutFile to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Maximilian Schüßler committed Jun 19, 2014
1 parent 84df9b3 commit 0c90e8f
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,14 @@ Commit some changes.
### `Repo#checkout(treeish, callback)`
`git checkout <treeish>`

### `Repo#checkoutFile([files, options, ]callback)`
Checkout some files.

* `files` - File(s) to checkout. Pass `'.'` or nothing to checkout all files.
* `options` -
- `force` - `Boolean`
* `callback` - Receives `(err)`.

### `Repo#sync([[remote, ]branch, ]callback)`
Sync the current branch with the remote, keeping all local changes intact.

Expand All @@ -194,6 +202,17 @@ The following steps are carried out: `stash`, `pull`, `push`, `stash pop`. If th
* `branch` - `String` (defaults to `master`).
* `callback` - Receives `(err)`.

### `Repo#reset([treeish, options, ]callback)`
Checkout files.

* `treeish` - The git object to reset to. Defaults to HEAD.
* `options` -
- `soft` - `Boolean`
- `mixed` - `Boolean` __default__
- `hard` - `Boolean`
- `merge` - `Boolean`
- `keep` - `Boolean`
* `callback` - Receives `(err)`.

## Commit
### `Commit#id`
Expand Down

0 comments on commit 0c90e8f

Please sign in to comment.