Skip to content

Commit

Permalink
Update to README about options and limitations
Browse files Browse the repository at this point in the history
  • Loading branch information
richardgirges authored Aug 25, 2016
1 parent 568a1cc commit ae32f43
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,19 @@ Install
npm install express-fileupload


Important Note
==============
Add `app.use(fileUpload())` AFTER `app.use(bodyParser.json)` and any other bodyParser middlewares! This limitation will be explored and resolved in an upcoming release.

Options
=======
Pass in Busboy options directly to express-fileupload (using Busboy `v0.2.13`). Check out the Busboy documentation here: https://github.com/mscdex/busboy#api
```javascript
app.use(fileUpload({
limits: { fileSize: 50 * 1024 * 1024 },
}));
```

Example
=======

Expand Down Expand Up @@ -60,4 +73,4 @@ app.post('/upload', function(req, res) {

## Thanks & Credit

* [Brian White](https://github.com/mscdex) for his stellar work on the [Busboy Package](https://github.com/mscdex/busboy) and the [connect-busboy Package](https://github.com/mscdex/connect-busboy)
* [Brian White](https://github.com/mscdex) for his stellar work on the [Busboy Package](https://github.com/mscdex/busboy) and the [connect-busboy Package](https://github.com/mscdex/connect-busboy)

0 comments on commit ae32f43

Please sign in to comment.