README.md
# angularjs-input-file
[![GitHub release][badge-release-img]][badge-release-lnk]
[![Greenkeeper badge][badge-greenkeeper-img]][badge-greenkeeper-lnk]
[![Travis CI Status][badge-travis-img]][badge-travis-lnk]
[![CircleCI][badge-circleci-img]][badge-circleci-lnk]
[![Code Climate Status][badge-code-climate-status-img]][badge-code-climate-status-lnk]
[![Code Climate Issues][badge-code-climate-issues-img]][badge-code-climate-issues-lnk]
[![License][badge-license-img]][badge-license-lnk]
An AngularJS component to select a file.
### TL;DR
- Demo and docs: [https://heyprof.github.io/angularjs-input-file/][site]
- Install with npm: `npm install angularjs-input-file --save`
- Install with bower: `bower install angularjs-input-file --save`
- Develop with `npm install` and `npm run serve`
- Contrib with fork, `npm install`, develop things, `npm run build` and fork request
### Specs:
Features:
- Vanilla AngularJS 1.5+ Component
- Bind ng-model with input type file
- No default css applied
Incoming-features:
- Hook an event when files loaded
### Usage && Demo
**See [example page][site] for doc and demo**
### Contrib
Start you should play with dependencies: `npm install`
Then you should be able to develop with: `npm run serve` (with hot reload)
Finally, if you want generate the dist folder: `npm run build`
That's it, you can create fork and submit your updates :)
- [Npm Guide](https://docs.npmjs.com/getting-started/publishing-npm-packages)
- [Bower Guide](https://bower.io/docs/creating-packages/)
### Execute tests TODO
*Warning: Not implemented yet*
`npm test`
### Contrib
Start you should play with dependencies: `npm install`
Then you should be able to develop with: `npm run serve` (with hot reload)
Finally, if you want generate the dist folder: `npm run build`
That's it, you can create fork and submit your updates :)
Technical TODOs:
- Yarn ?
- create doc with dgeni
- Create tests
- [Npm Guide](https://docs.npmjs.com/getting-started/publishing-npm-packages)
- [Bower Guide](https://bower.io/docs/creating-packages/)
### LICENCE
MIT License
Copyright (c) 2017 HeyProf!
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[site]: https://heyprof.github.io/angularjs-input-file/
[badge-release-img]: https://img.shields.io/github/release/heyprof/angularjs-input-file/all.svg
[badge-release-lnk]: https://github.com/heyprof/angularjs-input-file/releases
[badge-greenkeeper-img]: https://badges.greenkeeper.io/heyprof/angularjs-input-file.svg
[badge-greenkeeper-lnk]: https://greenkeeper.io/
[badge-circleci-img]: https://circleci.com/gh/heyprof/angularjs-input-file/tree/master.svg?style=svg
[badge-circleci-lnk]: https://circleci.com/gh/heyprof/angularjs-input-file/tree/master
[badge-code-climate-status-img]: https://img.shields.io/codeclimate/github/heyprof/angularjs-input-file.svg?label=climate
[badge-code-climate-status-lnk]: https://codeclimate.com/github/heyprof/angularjs-input-file
[badge-code-climate-issues-img]: https://img.shields.io/codeclimate/issues/github/heyprof/angularjs-input-file.svg?label=climate issues
[badge-code-climate-issues-lnk]: https://codeclimate.com/github/heyprof/angularjs-input-file/issues
[badge-license-img]: https://img.shields.io/badge/license-MIT-blue.svg
[badge-license-lnk]: https://raw.githubusercontent.com/heyprof/angularjs-input-file/master/LICENSE