summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorscott Chacon <schacon@agadorsparticus.(none)>2007-11-27 08:45:08 -0800
committerscott Chacon <schacon@agadorsparticus.(none)>2007-11-27 08:45:08 -0800
commite3d0951881c5829b525c6e846e356e23a2e084fa (patch)
tree018496f6cbeeaf71f6673b2aac716003546529fa
parent6bbead02aa2a60e7d50e68f3b2c98a14c26b2d81 (diff)
downloadthird_party-ruby-git-e3d0951881c5829b525c6e846e356e23a2e084fa.zip
third_party-ruby-git-e3d0951881c5829b525c6e846e356e23a2e084fa.tar.gz
third_party-ruby-git-e3d0951881c5829b525c6e846e356e23a2e084fa.tar.xz
added some information about gitr to the README file
-rw-r--r--README18
1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
index e71ec68..088ee28 100644
--- a/README
+++ b/README
@@ -19,6 +19,9 @@ 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.
+Many of the simple read-only operations have already been
+moved to pure ruby.
+
= Major Objects
Git::Base - this is the object returned from a Git.open or Git.clone.
@@ -47,6 +50,21 @@ your log query, which can be constructed through methods on the Git::Log object,
@git.log(20).object("HEAD^").since("2 weeks ago").between('v2.6', 'v2.7').each { |commit| [block] }
+= Gitr
+
+I have included a command line pure-ruby git client called 'gitr'
+
+The following commands are available - they all will run in pure ruby, without forking out the the git binary.
+In fact, they can be run on a machine without git compiled on it.
+
+commands: log
+ log-shas
+ cat-file (treeish)
+ rev-parse (treeish)
+ branches
+ config
+ ls-tree (tree)
+
= Examples