Automattic / knox

S3 Lib
MIT License
1.74k stars 285 forks source link

Documentation regarding progress #298

Open ChristianRich opened 8 years ago

ChristianRich commented 8 years ago

The documentation on upload progress is very sparse : "Note that both putFile and putStream will stream to S3 instead of reading into memory, which is great. And they return objects that emit 'progress' events too, so you can monitor how the streaming goes! The progress events have fields written, total, and percent."

Would it be possible to provide and example using putFile or putStream?