Skip to content

Commit 0bac653

Browse files
committed
docs: add additional description of the middleware
1 parent 103b304 commit 0bac653

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ var compression = require('compression')
2727

2828
### compression([options])
2929

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

3234
#### Options
3335

0 commit comments

Comments
 (0)