Add rudimentary README file. It still needs to be augmented.
authorEdward Z. Yang <edwardzyang@thewritingpot.com>
Sun, 20 Jul 2008 01:48:41 +0000 (19 21:48 -0400)
committerEdward Z. Yang <edwardzyang@thewritingpot.com>
Sun, 20 Jul 2008 01:48:41 +0000 (19 21:48 -0400)
Signed-off-by: Edward Z. Yang <edwardzyang@thewritingpot.com>
README.txt [new file with mode: 0644]

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..a15c6b9
--- /dev/null
@@ -0,0 +1,20 @@
+phpgit bindings
+    (Not to be confused with git-php!)
+
+phpgit is a PHP library for manipulating and retrieving information from
+Git repositories.  It wraps the Git executable in a nice manner, and also
+has various amounts of syntactical sugar in the form of quick and easy methods
+for common operations as well as a full-fledged Tree and Blob representation
+format.
+
+Well, at least, in theory. This is a port of GitPython (which itself is a port
+of grit), and it is incomplete. Please consult the source code to see which
+functions are implemented and which are not.
+
+Also, appropriate credits will be listed eventually here.
+
+Thanks,
+Edward
+
+P.S. When talking about this project, please refer to it as "phpgit bindings"
+to help disambiguate it against the web-interface, "git-php".