Skip to content

Commit ec7f968

Browse files
committed
Update README
Add badges Complete contrib section Minor updates
1 parent c20b41b commit ec7f968

File tree

1 file changed

+55
-9
lines changed

1 file changed

+55
-9
lines changed

README.md

Lines changed: 55 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,36 @@
1-
## angularjs-input-file
1+
# angularjs-input-file
2+
3+
[![GitHub release][badge-release-img]][badge-release-lnk]
4+
[![Dependencies Status][badge-dependencies-img]][badge-dependencies-lnk]
5+
[![Dev Dependencies Status][badge-dev-dependencies-img]][badge-dev-dependencies-lnk]
6+
[![Travis CI Status][badge-travis-img]][badge-travis-lnk]
7+
[![Code Climate Status][badge-code-climate-status-img]][badge-code-climate-status-lnk]
8+
[![Code Climate Issues][badge-code-climate-issues-img]][badge-code-climate-issues-lnk]
9+
[![License][badge-license-img]][badge-license-lnk]
210

311
An AngularJS component to select a file.
412

5-
### Install
13+
### TL;DR
614

7-
- npm: `npm install --save angularjs-input-file`
8-
- bower: `bower install --save angularjs-input-file`
15+
- Demo and docs: [https://heyprof.github.io/angularjs-input-file/][site]
16+
- Install with npm: `npm install angularjs-input-file --save`
17+
- Install with bower: `bower install angularjs-input-file --save`
18+
- Develop with `npm install` and `npm run serve`
19+
- Contrib with fork, `npm install`, develop things, `npm run build` and fork request
920

10-
### Technical specs:
21+
### Specs:
1122

1223
Features:
13-
- Easy AngularJS 1.5+ Component
24+
- Vanilla AngularJS 1.5+ Component
1425
- Bind ng-model with input type file
1526
- No default css applied
1627

1728
Incoming-features:
1829
- Hook an event when files loaded
1930

20-
### Usage
31+
### Usage && Demo
2132

22-
**See [example page](https://heyprof.github.io/angularjs-input-file/) for doc and demo**
33+
**See [example page][site] for doc and demo**
2334

2435
### Contrib
2536

@@ -40,6 +51,24 @@ That's it, you can create fork and submit your updates :)
4051

4152
`npm test`
4253

54+
### Contrib
55+
56+
Start you should play with dependencies: `npm install`
57+
58+
Then you should be able to develop with: `npm run serve` (with hot reload)
59+
60+
Finally, if you want generate the dist folder: `npm run build`
61+
62+
That's it, you can create fork and submit your updates :)
63+
64+
Technical TODOs:
65+
- Yarn ?
66+
- create doc with dgeni
67+
- Create tests
68+
69+
- [Npm Guide](https://docs.npmjs.com/getting-started/publishing-npm-packages)
70+
- [Bower Guide](https://bower.io/docs/creating-packages/)
71+
4372
### LICENCE
4473

4574
MIT License
@@ -62,4 +91,21 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
6291
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
6392
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
6493
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
65-
SOFTWARE.
94+
SOFTWARE.
95+
96+
[site]: https://heyprof.github.io/angularjs-input-file/
97+
98+
[badge-release-img]: https://img.shields.io/github/release/heyprof/angularjs-input-file/all.svg?style=flat-square
99+
[badge-release-lnk]: https://github.com/heyprof/angularjs-input-file/releases
100+
[badge-dependencies-img]: https://img.shields.io/david/heyprof/angularjs-input-file.svg?style=flat-square
101+
[badge-dependencies-lnk]: https://david-dm.org/heyprof/angularjs-input-file
102+
[badge-dev-dependencies-img]: https://img.shields.io/david/dev/heyprof/angularjs-input-file.svg?style=flat-square
103+
[badge-dev-dependencies-lnk]: https://david-dm.org/heyprof/angularjs-input-file?type=dev
104+
[badge-travis-img]: https://img.shields.io/travis/heyprof/angularjs-input-file.svg?style=flat-square&label=TravisCI
105+
[badge-travis-lnk]: https://travis-ci.org/heyprof/angularjs-input-file
106+
[badge-code-climate-status-img]: https://img.shields.io/codeclimate/github/heyprof/angularjs-input-file.svg?style=flat-square&label=climate
107+
[badge-code-climate-status-lnk]: https://codeclimate.com/github/heyprof/angularjs-input-file
108+
[badge-code-climate-issues-img]: https://img.shields.io/codeclimate/issues/github/heyprof/angularjs-input-file.svg?style=flat-square&label=climate issues
109+
[badge-code-climate-issues-lnk]: https://codeclimate.com/github/heyprof/angularjs-input-file/issues
110+
[badge-license-img]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
111+
[badge-license-lnk]: https://raw.githubusercontent.com/heyprof/angularjs-input-file/master/LICENSE

0 commit comments

Comments
 (0)