summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorscott Chacon <schacon@agadorsparticus.(none)>2007-11-11 17:59:18 -0800
committerscott Chacon <schacon@agadorsparticus.(none)>2007-11-11 17:59:18 -0800
commit646304a6e7c3b2c442a0a7db995629e7009c3a14 (patch)
tree0475bc78d2f805a36c91a898804e099634d8c54a /README
parent31b4f2b80616f570c83ed62d20f8b14ec5ba425b (diff)
downloadthird_party-ruby-git-646304a6e7c3b2c442a0a7db995629e7009c3a14.tar.gz
third_party-ruby-git-646304a6e7c3b2c442a0a7db995629e7009c3a14.tar.xz
third_party-ruby-git-646304a6e7c3b2c442a0a7db995629e7009c3a14.zip
added documentation and a license file
Diffstat (limited to 'README')
-rw-r--r--README50
1 files changed, 5 insertions, 45 deletions
diff --git a/README b/README
index 5f9c69a..5e80466 100644
--- a/README
+++ b/README
@@ -1,8 +1,11 @@
-Git Library for Ruby
------------------------------
+== Git Library for Ruby
+
+= What it is
Library for using Git in Ruby.
+= Roadmap
+
Right now I'm forking calls to the 'git' binary,
but eventually I'll replace that with either C bindings
to libgit or libgit-thin, or I'll write pure ruby
@@ -11,46 +14,3 @@ handlers for at least some of the Git stuff.
See EXAMPLES file for, well, examples.
-
-Git::Object
- - sha
- - type
- - cat_file
- - raw
-
-Git::Commit
- - tree
- - parent
- - author # git author
- - author_date
- - committer # git author
- - committer_date / date
- - message
-
-Git::Tree
- - children
- - blobs/files
- - subtrees/subdirs
-
-Git::Blob << File
- - size
- - permissions
-
-Git::Tag
-
-Git::Hash
- - abbrev/short
-
-Git::Repository
- - heads
- - refs
- - branches
-
-Git::WorkingDirectory
- - foreach
- - glob # returns Git::Files
-
-Git::File << File
- - log
- - tags
-