Skip to content

Commit

Permalink
docs: add additional description of the middleware
Browse files Browse the repository at this point in the history
  • Loading branch information
dougwilson committed Sep 30, 2015
1 parent 103b304 commit 0bac653
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ var compression = require('compression')

### compression([options])

Returns the compression middleware using the given `options`.
Returns the compression middleware using the given `options`. The middleware
will attempt to compress response bodies for all request that traverse through
the middleware, based on the given `options`.

#### Options

Expand Down

0 comments on commit 0bac653

Please sign in to comment.