diff --git a/README.md b/README.md index 5100265..787504e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,49 @@ # ng2-file-upload -Easy to use Angular2 components for files upload +Easy to use Angular2 directives for files upload -## Placeholder for `ng2-file-upload` angular2 module +Native File Upload Angular2 directives -Please read central `ng2` modules [readme](https://github.com/valor-software/ng2-plans) for details, plans and approach +## Quick start + +1. A recommended way to install ***ng2-file-upload*** is through [npm](https://www.npmjs.com/search?q=ng2-file-upload) package manager using the following command: + + `npm i ng2-file-upload --save` + + Alternatively, you can [download it in a ZIP file](https://github.com/valor-software/ng2-file-upload/archive/master.zip). + +2. Currently `ng2-file-upload` contains two directives: `ng2-file-select` and `ng2-file-drop`. `ng2-file-select` is used for 'file-input' field of form and + `ng2-file-drop` is used for area that will be used for dropping of file or files. + +3. More information regarding using of ***ng2-file-upload*** is located in + [demo](http://valor-software.github.io/ng2-file-upload/) and [demo sources](https://github.com/valor-software/ng2-file-upload/tree/master/demo). + +## API for `ng2-file-select` + +### Properties + + - `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) + +## API for `ng2-file-drop` + +### Properties + + - `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) + +### Events + + - `file-over` - it fires during 'over' and 'out' events for Drop Area; returns `boolean`: `true` if file is over Drop Area, `false` in case of out. + See using in [ts demo](https://github.com/valor-software/ng2-file-upload/blob/master/demo/components/file-upload/simple-demo.ts) and + [html demo](https://github.com/valor-software/ng2-file-upload/blob/master/demo/components/file-upload/simple-demo.html) + +# Troubleshooting + +Please follow this guidelines when reporting bugs and feature requests: + +1. Use [GitHub Issues](https://github.com/valor-software/ng2-file-upload/issues) board to report bugs and feature requests (not our email address) +2. Please **always** write steps to reproduce the error. That way we can focus on fixing the bug, not scratching our heads trying to reproduce it. + +Thanks for understanding! + +### License + +The MIT License (see the [LICENSE](https://github.com/valor-software/ng2-file-upload/blob/master/LICENSE) file for the full text)