Permalink
Browse files

0.0.1, document opts and bound params

  • Loading branch information...
1 parent ce9ce9b commit 89fd7fd74fb66559a8c3a57a1261614a2871dcf4 @substack committed Oct 3, 2012
Showing with 8 additions and 3 deletions.
  1. +1 −1 package.json
  2. +7 −2 readme.markdown
View
@@ -1,6 +1,6 @@
{
"name" : "git-file",
- "version" : "0.0.0",
+ "version" : "0.0.1",
"description" : "read file and directory data from a git repo as streams",
"main" : "index.js",
"directories" : {
View
@@ -39,7 +39,7 @@ git.read(commit, file).pipe(process.stdout);
var git = require('git-file')
```
-## git.list(ref, dir)
+## git.list(ref, dir, opts)
List the contents of a directory `dir` at the
[revision](http://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html)
@@ -48,12 +48,17 @@ List the contents of a directory `dir` at the
Returns a stream with a `'data'` event for each file where directories have a
trailing `'/'`.
-## git.read(ref, file)
+## git.read(ref, file, opts)
Return a stream with the contents of `file` at the
[revision](http://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html)
`ref`.
+## git(ref, opts)
+
+Return an object with `list` and `read` bound to the `ref` and/or `opts`
+provided.
+
# install
With [npm](https://npmjs.org) do:

0 comments on commit 89fd7fd

Please sign in to comment.