danog/gift
1
0
Fork 0
mirror of https://github.com/danog/gift.git synced 2024-12-02 09:17:55 +01:00
Code Issues Projects Releases Wiki Activity

Add Repo#reset & Repo#checkoutFile to README

Browse Source
This commit is contained in:
Maximilian Schüßler 2014-06-19 21:34:10 +02:00
parent 84df9b382f
commit 0c90e8f489
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -185,6 +185,14 @@ Commit some changes.
### `Repo#checkout(treeish, callback)` ### `Repo#checkout(treeish, callback)`
`git checkout <treeish>` `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)` ### `Repo#sync([[remote, ]branch, ]callback)`
Sync the current branch with the remote, keeping all local changes intact. Sync the current branch with the remote, keeping all local changes intact.
@ -194,6 +202,17 @@ The following steps are carried out: `stash`, `pull`, `push`, `stash pop`. If th
* `branch` - `String` (defaults to `master`). * `branch` - `String` (defaults to `master`).
* `callback` - Receives `(err)`. * `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
### `Commit#id` ### `Commit#id`