From e351a39101b89a26994a32f4da72968234154cf1 Mon Sep 17 00:00:00 2001 From: Tim Donohue Date: Mon, 6 Jun 2016 09:31:10 -0500 Subject: [PATCH] Add basic docs --- README.md | 3 ++- components/file-upload/readme.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c4ced13..8914ec2 100644 --- a/README.md +++ b/README.md @@ -37,10 +37,11 @@ Follow me [![twitter](https://img.shields.io/twitter/follow/valorkin.svg?style=s - `uploader` - (`FileUploader`) - uploader object. See using in [demo](https://github.com/valor-software/ng2-file-upload/blob/master/demo/components/file-upload/simple-demo.ts) - Parameters that supported by this object: + Parameters supported by this object: 1. `url` - URL of File Uploader's route 2. `authToken` - Auth token that will be applied as 'Authorization' header during file send. + 3. `disableMultipart` - If 'true', disable using a multipart form for file upload and instead stream the file. Some APIs (e.g. Amazon S3) may expect the file to be streamed rather than sent via a form. Defaults to false. ### Events diff --git a/components/file-upload/readme.md b/components/file-upload/readme.md index 62b9b18..c1f7d2d 100644 --- a/components/file-upload/readme.md +++ b/components/file-upload/readme.md @@ -20,10 +20,11 @@ import {FileSelectDirective, FileDropDirective, FileUploader} from 'ng2-file-upl - `uploader` - (`FileUploader`) - uploader object. See using in [demo](https://github.com/valor-software/ng2-file-upload/blob/master/demo/components/file-upload/simple-demo.ts) - Parameters that supported by this object: + Parameters supported by this object: 1. `url` - URL of File Uploader's route 2. `authToken` - auth token that will be applied as 'Authorization' header during file send. + 3. `disableMultipart` - If 'true', disable using a multipart form for file upload and instead stream the file. Some APIs (e.g. Amazon S3) may expect the file to be streamed rather than sent via a form. Defaults to false. ## FileDrop API