Skip to content

Commit

Permalink
[README] #status, #identity and #identify
Browse files Browse the repository at this point in the history
  • Loading branch information
notatestuser committed Mar 17, 2013
1 parent 1846098 commit 3afe421
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A simple Node.js wrapper for the Git CLI. The API is based on
# API

git = require 'gift'

repo = git "path/to/repo"
# => #<Repo>

Expand Down Expand Up @@ -57,6 +57,16 @@ Get the difference between the trees.

The callback receives `(err, diffs)`.

### `Repo#identity(callback)`
Get the commit identity for this repository.

The callback receives `(err, actor)`, where `actor` is an Actor.

### `Repo#identify(actor, callback)`
Set your account's default identity for commits to this repository.

The callback receives `(err)`.

### `Repo#remotes(callback)`
Get the repository's remotes.

Expand All @@ -73,9 +83,8 @@ Equivalent to `git remote add <name> <url>`.
### `Repo#remote_fetch(name, callback)`
`git fetch <name>`


### `Repo#status(callback)`
The callback receives `(err, status)`.
Uses `--porcelain` to parse repository status in a way that is agnostic of system language. The callback receives `(err, status)`. See below for a definition of what `status` is.

### `Repo#create_branch(name, callback)`
Create a new branch with `name`, and call the callback when complete
Expand Down

0 comments on commit 3afe421

Please sign in to comment.