From 38f009d6d0aa35b13d19575611db1c724a9d1a5b Mon Sep 17 00:00:00 2001 From: scott Chacon Date: Tue, 13 Nov 2007 07:36:50 -0800 Subject: updated a bunch of the documentation --- README | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'README') diff --git a/README b/README index cc37f4c..c10117d 100644 --- a/README +++ b/README @@ -19,6 +19,27 @@ but eventually I'll replace that with either C bindings to libgit or libgit-thin, or I'll write pure ruby handlers for at least some of the Git stuff. += Major Objects + +Git::Base - this is the object returned from a Git.open or Git.clone. +Most major actions are called from this object. + +Git::Object - this is the base object for your tree, blob and commit objects, +returned from @git.gtree or @git.object calls. the Git::AbstractObject will +have most of the calls in common for all those objects. + +Git::Diff - returns from a @git.diff command. It is an Enumerable that returns +Git::Diff:DiffFile objects from which you can get per file patches and insertion/deletion +statistics. You can also get total statistics from the Git::Diff object directly. + +Git::Status + +Git::Branches + +Git::Remote + +Git::Log + = Examples -- cgit