Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
schwarzkopfb committed Jul 20, 2016
1 parent b1c4374 commit b2aa5ab
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@

# adir

Utility for recursive aggregation of directory trees
Utility for recursive aggregation of directory trees.
Useful for creating directory [indices](/examples/tree.js),
[searching](/examples/search.js) by file attributes,
performing [calculations](/examples/directory-size.js) on a directory tree,
building dynamic [routing tables](/examples/express-routes.js), etc.

## Usage

Expand Down Expand Up @@ -42,6 +46,9 @@ aggregate('./', onEntry, tree, done)

## Compatibility

`adir` is compatible with Node 0.8 and above but a `Promise` implementation is required even if you're only using the callback API.
Tested with [bluebird](https://www.npmjs.com/package/bluebird).

## Installation

With npm:
Expand Down

0 comments on commit b2aa5ab

Please sign in to comment.