Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelnisi committed Aug 29, 2013
1 parent b0219bf commit 1223197
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 7 deletions.
8 changes: 2 additions & 6 deletions README.md
@@ -1,6 +1,6 @@
# showf - show changed files in latest commit

The showf [Node.js](http://nodejs.org/) module shows filenames of changed files in the latest commit.
The showf [Node.js](http://nodejs.org/) module shows filenames of changed files in the latest commit to a local git repository.

[![Build Status](https://secure.travis-ci.org/michaelnisi/showf.png)](http://travis-ci.org/michaelnisi/showf) [![David DM](https://david-dm.org/michaelnisi/showf.png)](http://david-dm.org/michaelnisi/showf)

Expand All @@ -15,14 +15,10 @@ The showf [Node.js](http://nodejs.org/) module shows filenames of changed files

### showf(dir)

The `showf` module exports a single function that returns a [Transform](http://nodejs.org/api/stream.html#stream_class_stream_transform) stream. The output of the stream are filenames of changed files in the last commit.
The `showf` module exports a single function that returns a [Transform](http://nodejs.org/api/stream.html#stream_class_stream_transform) stream. The output of the stream are filenames of changed files in the latest commit.

## Installation

Install with [npm](https://npmjs.org):

npm install showf

[![NPM](https://nodei.co/npm/showf.png)](https://npmjs.org/package/showf)

## License
Expand Down
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "showf",
"version": "0.0.2",
"version": "0.0.3",
"description": "show filenames of changed files in latest commit",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 1223197

Please sign in to comment.