From 3afe421d388cb088be30639b2cc0edb1f5d08cc2 Mon Sep 17 00:00:00 2001 From: Luke Plaster Date: Sun, 17 Mar 2013 15:35:37 +0000 Subject: [PATCH] [README] #status, #identity and #identify --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d4df787..44ae6ca 100644 --- a/README.md +++ b/README.md @@ -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" # => # @@ -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. @@ -73,9 +83,8 @@ Equivalent to `git remote add `. ### `Repo#remote_fetch(name, callback)` `git fetch ` - ### `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