added readme file

Author: Luca

Makefile

@@ -1,4 +1,5 @@
 test:
 	@unzip test/testRepo.zip -d test/
 	@./node_modules/.bin/mocha --ignore-leaks 
+	
 .PHONY: test

README.md

@@ -0,0 +1,39 @@
+# GitReader
+
+  Read and format git object from a git Repo
+
+## How to use
+  
+  var gitReader = require('gitReader')
+    , repo = gitReader.init('.');
+
+  repo.getBranches(function (err, branches) { });
+  repo.getObject(sha1, function (err, result) { });
+
+## How to test
+  
+  npm test
+
+## License 
+
+(The MIT License)
+
+Copyright (c) 2011 Luca Lanziani <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

index.js

@@ -0,0 +1,3 @@
+var repo = require('./lib/repo.js');
+
+module.exports.init = repo.init;