UNPKG

availity-angular/README.md

Version:

2.16 kBMarkdownView Raw

1# availity-angular
2
3> Availity Angular SDK
4
5[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square&label=license)](http://opensource.org/licenses/MIT)
6[![NPM](http://img.shields.io/npm/v/availity-angular.svg?style=flat-square&label=npm)](https://npmjs.org/package/availity-angular)
7[![Dependency Status](https://img.shields.io/david/dev/Availity/availity-angular.svg?style=flat-square)](https://david-dm.org/Availity/availity-angular)
8[![Build](https://img.shields.io/travis/Availity/availity-angular.svg?style=flat-square&label=build)](https://travis-ci.org/Availity/availity-angular)
9
10## Table of Contents
11
12* [Intro](#intro)
13* [Demo](#demo)
14* [Supported Browsers](#supported-browsers)
15* [Quickstart](#quickstart)
16* [Upgrading](#upgrading)
17* [Angular](#angular)
18* [Acknowledgments](#acknowledgments)
19* [Authors](#authors)
20* [License](#license)
21
22## Intro
23
24## Demo
25
26[availity.github.io/availity-angular](http://availity.github.io/availity-angular/)
27
28## Supported Browsers
29
30* Internet Explorer 9 and newer
31* Google Chrome
32* Mozilla Firefox
33
34> Other browsers should be supported as well but you may experience some issues.
35
36## Quickstart
37
38Install the Availity Angular SDK with npm.
39
40```bash
41$ npm install availity-angular --save
42```
43
44## Acknowledgments
45
46The Availity Angular lib was heavily inspired by multiple open source frameworks.  If for some reason a library could not be used directly (IE9 limitation), we've reused that projects code directly in this project.  Please check out the libs below for some beautifully written code.
47
48+ [Angular Strap](https://github.com/mgcrea/angular-strap)
49+ [Angular Bootstrap](https://github.com/angular-ui/bootstrap)
50+ [Valdr](https://github.com/netceteragroup/valdr)
51
52## Contributing
53
541. Ensure release is occurring on `master` branch: `git checkout master`
552. Run `npm test` and ensure all test are passing
563. Run `npm run build`
574. Run `npm version ${version}` where version is the appropriate semantic release number. 
585. Run `npm publish`. You must be listed as a collaborator https://www.npmjs.com/package/availity-angular for this step to work.
59
60## License
61
62Copyright (c) 2017 Availity, LLC

1	`# availity-angular`
2
3	`> Availity Angular SDK`
4
5	`[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square&label=license)](http://opensource.org/licenses/MIT)`
6	`[![NPM](http://img.shields.io/npm/v/availity-angular.svg?style=flat-square&label=npm)](https://npmjs.org/package/availity-angular)`
7	`[![Dependency Status](https://img.shields.io/david/dev/Availity/availity-angular.svg?style=flat-square)](https://david-dm.org/Availity/availity-angular)`
8	`[![Build](https://img.shields.io/travis/Availity/availity-angular.svg?style=flat-square&label=build)](https://travis-ci.org/Availity/availity-angular)`
9
10	`## Table of Contents`
11
12	`* [Intro](#intro)`
13	`* [Demo](#demo)`
14	`* [Supported Browsers](#supported-browsers)`
15	`* [Quickstart](#quickstart)`
16	`* [Upgrading](#upgrading)`
17	`* [Angular](#angular)`
18	`* [Acknowledgments](#acknowledgments)`
19	`* [Authors](#authors)`
20	`* [License](#license)`
21
22	`## Intro`
23
24	`## Demo`
25
26	`[availity.github.io/availity-angular](http://availity.github.io/availity-angular/)`
27
28	`## Supported Browsers`
29
30	`* Internet Explorer 9 and newer`
31	`* Google Chrome`
32	`* Mozilla Firefox`
33
34	`> Other browsers should be supported as well but you may experience some issues.`
35
36	`## Quickstart`
37
38	`Install the Availity Angular SDK with npm.`
39
40	```bash
41	`$ npm install availity-angular --save`
42	```
43
44	`## Acknowledgments`
45
46	`The Availity Angular lib was heavily inspired by multiple open source frameworks. If for some reason a library could not be used directly (IE9 limitation), we've reused that projects code directly in this project. Please check out the libs below for some beautifully written code.`
47
48	`+ [Angular Strap](https://github.com/mgcrea/angular-strap)`
49	`+ [Angular Bootstrap](https://github.com/angular-ui/bootstrap)`
50	`+ [Valdr](https://github.com/netceteragroup/valdr)`
51
52	`## Contributing`
53
54	1. Ensure release is occurring on `master` branch: `git checkout master`
55	2. Run `npm test` and ensure all test are passing
56	3. Run `npm run build`
57	4. Run `npm version ${version}` where version is the appropriate semantic release number.
58	5. Run `npm publish`. You must be listed as a collaborator https://www.npmjs.com/package/availity-angular for this step to work.
59
60	`## License`
61
62	`Copyright (c) 2017 Availity, LLC`