From fc4b19eff12f4fee6a61931c11366d5138dae92f Mon Sep 17 00:00:00 2001
From: Scott Chacon <schacon@gmail.com>
Date: Tue, 25 May 2010 08:01:03 -0700
Subject: [PATCH] added readme file

---
 README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c4db9bf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+Geef (Git NIF)
+================
+
+Geef is a simple Erlang NIF that exposes some of the libgit2 library functions
+to Erlang.
+
+INSTALLING AND RUNNING
+========================
+
+First you need to install libgit2 (gsoc edition):
+
+    $ git clone git://github.com/tanoku/libgit2-gsoc2010.git
+    $ cd libgit2
+    $ make
+    $ make install
+
+Now, if you have Erlang OTP_R13B04 installed, you can compile this NIF to run
+in it.
+
+    $ git clone git://github.com/schacon/geef.git
+    $ cd geef
+    $ make
+
+Now you should have a .beam file you can load.  I've also included an example
+escript to test some of the functions (currently just hex_to_raw and object_exists):
+
+    $ ./geef h2r de08fe4884650f067bd5703b8a59a8b3b3c99aaa
+    Raw: <<222,8,254,72,132,101,15,6,123,213,112,59,138,89,168,179,179,201,154,170>>
+
+    $ ./geef exists .git/objects 89c86150c8b164f441a73f4991b2c339fd4aae7c
+    Exists: true
+
+    $ ./geef exists .git/objects 87fcfb277899097823911006f438658ce86b3697
+    Exists: false
+
+The API looks basically like this:
+
+    geef:start().
+    Raw = geef:hex_to_raw(HexSha).
+    Exists = geef:object_exists(ObjectsPath, HexSha).
+
+
+CONTRIBUTING
+==============
+
+Fork schacon/ribbit on GitHub, make it awesomer (preferably in a branch named
+for the topic), send a pull request.
+
+
+AUTHORS 
+==============
+
+Scott Chacon <schacon@gmail.com>
+
+
+LICENSE
+==============
+
+MIT.
+