Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More reformatting markdown in README #1942

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

More reformatting markdown in README #1942

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b85903
Re-format markdown in README
Kevinlearynet Jun 8, 2017
d1639a5
Correct H3's in README
Kevinlearynet Jun 8, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 9 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For bug report or feature request please search through existing [issues](https:
If you like this plugin give it a thumbs up at [ngmodules](http://ngmodules.org/modules/ng-file-upload) or get me a <a target="_blank" href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=danial%2efarid%40gmail%2ecom&lc=CA&item_name=ng%2dfile%2dupload&item_number=ng%2dfile%2dupload&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted">cup of tea <img src="https://angular-file-upload.appspot.com/img/tea.png" width="40" height="24" title="Icon made by Freepik.com"></a>. Contributions are welcomed.


Table of Content:
## Table of Contents
* [Features](#features)
* [Install](#install) ([Manual](#manual), [Bower](#bower), [NuGet](#nuget), [NPM](#npm))
* [Usage](#usage)
Expand All @@ -31,7 +31,7 @@ Table of Content:
* [CORS](#cors)
* [Amazon S3 Upload](#s3)

##<a name="features"></a> Features
## <a name="features"></a>Features
* file upload progress, cancel/abort
* file drag and drop (html5 only)
* image paste from clipboard and drag and drop from browser pages (html5 only).
Expand All @@ -46,7 +46,7 @@ Table of Content:
* HTML5 FileReader.readAsDataURL shim for IE8-9
* available on [npm](https://www.npmjs.com/package/ng-file-upload), [bower](https://libraries.io/bower/ng-file-upload), [meteor](https://atmospherejs.com/danialf/ng-file-upload), [nuget](https://www.nuget.org/packages/angular-file-upload)

##<a name="install"></a> Install
## <a name="install"></a>Install

* <a name="manual"></a>**Manual**: download latest from [here](https://github.com/danialfarid/ng-file-upload-bower/releases/latest)
* <a name="bower"></a>**Bower**:
Expand All @@ -60,9 +60,9 @@ Table of Content:
<script src="ng-file-upload(.min).js"></script>
```

##<a name="usage"></a> Usage
## <a name="usage"></a>Usage

###Samples:
### Samples
* Upload with form submit and validations: [http://jsfiddle.net/danialfarid/maqbzv15/1118/](http://jsfiddle.net/danialfarid/maqbzv15/1118/)
* Upload multiple files one by one on file select:
[http://jsfiddle.net/danialfarid/2vq88rfs/136/](http://jsfiddle.net/danialfarid/2vq88rfs/136/)
Expand Down Expand Up @@ -105,7 +105,7 @@ Image thumbnail: <img ngf-thumbnail="file || '/thumb.jpg'">
Audio preview: <audio controls ngf-src="file"></audio>
Video preview: <video controls ngf-src="file"></video>
```
Javascript code:
### JavaScript Code
```js
//inject directives and services.
var app = angular.module('fileUpload', ['ngFileUpload']);
Expand Down Expand Up @@ -459,7 +459,7 @@ On your server you need to keep track of what files are being uploaded and how m



##<a name="old_browsers"></a> Old browsers
## <a name="old_browsers"></a>Old browsers

For browsers not supporting HTML5 FormData (IE8, IE9, ...) [FileAPI](https://github.com/mailru/FileAPI) module is used.
**Note**: You need Flash installed on your browser since `FileAPI` uses Flash to upload files.
Expand Down Expand Up @@ -491,7 +491,7 @@ You can place these two files beside `angular-file-upload-shim(.min).js` on your
* In case of an error response (http code >= 400) the custom error message returned from the server may not be available. For some error codes flash just provide a generic error message and ignores the response text. [#310](https://github.com/danialfarid/ng-file-upload/issues/310)
* Older browsers won't allow `PUT` requests. [#261](https://github.com/danialfarid/ng-file-upload/issues/261)

##<a name="server"></a>Server Side
## <a name="server"></a>Server Side

* <a name="java"></a>**Java**
You can find the sample server code in Java/GAE [here](https://github.com/danialfarid/ng-file-upload/blob/master/demo/src/main/java/com/df/angularfileupload/)
Expand All @@ -511,7 +511,7 @@ provided by [Coshx Labs](http://www.coshx.com/).
* [Demo](https://github.com/stewartm83/angular-fileupload-sample) showing how to use ng-file-upload with Asp.Net Web Api.
* Sample client and server code [demo/C#](https://github.com/danialfarid/ng-file-upload/tree/master/demo/C%23) provided by [AtomStar](https://github.com/AtomStar)

##<a name="cors"></a>CORS
## <a name="cors"></a>CORS
To support CORS upload your server needs to allow cross domain requests. You can achieve that by having a filter or interceptor on your upload file server to add CORS headers to the response similar to this:
([sample java code](https://github.com/danialfarid/ng-file-upload/blob/master/demo/src/main/java/com/df/angularfileupload/CORSFilter.java))
```java
Expand Down Expand Up @@ -610,9 +610,4 @@ Make sure that you provide upload and CORS post to your bucket at AWS -> S3 -> b

For IE8-9 flash polyfill you need to have a <a href='#crossdomain'>crossdomain.xml</a> file at the root of you S3 bucket. Make sure the content-type of crossdomain.xml is text/xml and you provide read access to this file in your bucket policy.


You can also have a look at [https://github.com/nukulb/s3-angular-file-upload](https://github.com/nukulb/s3-angular-file-upload) for another example with [this](https://github.com/danialfarid/ng-file-upload/issues/814#issuecomment-112198426) fix.