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 | [![Build](https://img.shields.io/travis/Availity/availity-angular.svg?style=flat-square&label=build)](https://travis-ci.org/Availity/availity-angular)
|
8 |
|
9 | ## Table of Contents
|
10 |
|
11 | * [Intro](#intro)
|
12 | * [Demo](#demo)
|
13 | * [Supported Browsers](#supported-browsers)
|
14 | * [Quickstart](#quickstart)
|
15 | * [Upgrading](#upgrading)
|
16 | * [Angular](#angular)
|
17 | * [Acknowledgments](#acknowledgments)
|
18 | * [Authors](#authors)
|
19 | * [License](#license)
|
20 |
|
21 | ## Intro
|
22 |
|
23 | ## Demo
|
24 |
|
25 | [availity.github.io/availity-angular](http://availity.github.io/availity-angular/)
|
26 |
|
27 | ## Supported Browsers
|
28 |
|
29 | * Internet Explorer 9 and newer
|
30 | * Google Chrome
|
31 | * Mozilla Firefox
|
32 |
|
33 | > Other browsers should be supported as well but you may experience some issues.
|
34 |
|
35 | ## Quickstart
|
36 |
|
37 | Install the Availity Angular SDK with npm.
|
38 |
|
39 | ```bash
|
40 | $ npm install availity-angular --save
|
41 | ```
|
42 |
|
43 | ## Acknowledgments
|
44 |
|
45 | 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.
|
46 |
|
47 | + [Angular Strap](https://github.com/mgcrea/angular-strap)
|
48 | + [Angular Bootstrap](https://github.com/angular-ui/bootstrap)
|
49 | + [Valdr](https://github.com/netceteragroup/valdr)
|
50 |
|
51 | ## Contributing
|
52 |
|
53 | [![Dependency Status](https://img.shields.io/david/dev/Availity/availity-angular.svg?style=flat-square)](https://david-dm.org/Availity/availity-angular)
|
54 |
|
55 |
|
56 | 1. Ensure release is occurring on `master` branch: `git checkout master`
|
57 | 1. Run `npm install` to ensure dependencies are up to date.
|
58 | 1. Run `npm test` and ensure all test are passing
|
59 | 1. Run `npm run release`
|
60 |
|
61 |
|
62 | ## License
|
63 |
|
64 | Copyright (c) 2017-present Availity, LLC. Code released under the [the MIT license](LICENSE)
|