|
1 | 1 | <p align="center"> |
2 | | - <img height="256px" width="256px" style="text-align: center;" src="https://cdn.rawgit.com/angular-material-extensions/core/master/demo/src/assets/logo.svg"> |
| 2 | + <img alt="angular-material-extensions's logo" |
| 3 | + height="256px" width="256px" style="text-align: center;" |
| 4 | + src="https://cdn.rawgit.com/angular-material-extensions/core/master/assets/angular-material-extensions-logo.svg"> |
3 | 5 | </p> |
4 | 6 |
|
5 | | -# core - Set of components, directives and services to boost the app development with angular material 2 |
| 7 | +# @angular-material-extensions/core - Open source library that includes a set of components, directives and services to boost the app development with angular material 2 |
6 | 8 |
|
7 | | -[](https://badge.fury.io/js/core), |
| 9 | +[](https://badge.fury.io/js/%40angular-material-extensions%2Fcore) |
| 10 | +[](https://angular-material-extensions.github.io/core) |
| 11 | +[](https://angular-material-extensions.github.io/core/doc/index.html) |
| 12 | +[](https://gitter.im/angular-material-extensions/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
| 13 | +[](https://circleci.com/gh/angular-material-extensions/core) |
8 | 14 | [](https://travis-ci.org/angular-material-extensions/core) |
9 | | -[](https://coveralls.io/github/angular-material-extensions/core?branch=master) |
| 15 | +[](https://codecov.io/gh/angular-material-extensions/core) |
10 | 16 | [](https://david-dm.org/angular-material-extensions/core) |
11 | 17 | [](https://david-dm.org/angular-material-extensions/core#info=devDependencies) |
12 | 18 | [](https://greenkeeper.io/) |
| 19 | +[](https://github.com/angular-material-extensions/core/blob/master/LICENSE) |
| 20 | + |
| 21 | +## Built by and for developers :heart: |
| 22 | +Do you have any question or suggestion ? Please do not hesitate to contact us! |
| 23 | +Alternatively, provide a PR | open an appropriate issue [here](https://github.com/angular-material-extensions/password-strength/issues) |
| 24 | + |
| 25 | +If you like this project, support [angular-material-extensions](https://github.com/angular-material-extensions) |
| 26 | +by starring :star: and sharing it :loudspeaker: |
| 27 | + |
| 28 | +## Table of Contents |
| 29 | +- [Demo](#demo) |
| 30 | +- [Components](#components) |
| 31 | + |
| 32 | +- [Dependencies](#dependencies) |
| 33 | +- [Installation](#installation) |
| 34 | +- [API](#api) |
| 35 | +- [Usage](#usage) |
| 36 | + |
| 37 | +- [Run Demo App Locally](#run-demo-app-locally) |
| 38 | +- [Development](#development) |
| 39 | +- [Other Angular Libraries](#other-angular-libraries) |
| 40 | +- [Support](#support) |
| 41 | +- [License](#license) |
13 | 42 |
|
14 | 43 | ## Demo |
15 | 44 |
|
16 | 45 | View all the directives in action at https://angular-material-extensions.github.io/core |
17 | 46 |
|
18 | | -## Dependencies |
19 | | -* [Angular](https://angular.io) (*requires* Angular 2 or higher, tested with 2.0.0) |
20 | 47 |
|
21 | | -## Installation |
22 | | -Install above dependencies via *npm*. |
23 | 48 |
|
24 | | -Now install `core` via: |
25 | | -```shell |
26 | | -npm install --save core |
27 | | -``` |
| 49 | +## Other Angular Libraries |
| 50 | +- [ngx-auth-firebaseui](https://github.com/AnthonyNahas/ngx-auth-firebaseui) |
| 51 | +- [ngx-linkifyjs](https://github.com/AnthonyNahas/ngx-linkifyjs) |
| 52 | +- [@firebaseui/ng-bootstrap](https://github.com/firebaseui/ng-bootstrap) |
| 53 | +- [@angular-material-extensions/password-strength](https://github.com/angular-material-extensions/password-strength) |
| 54 | +- [@angular-material-extensions/google-maps-autocomplete](https://github.com/angular-material-extensions/google-maps-autocomplete) |
| 55 | +- [@angular-material-extensions/link-preview](https://github.com/angular-material-extensions/link-preview) |
| 56 | +- [@angular-material-extensions/pages](https://github.com/angular-material-extensions/pages) |
| 57 | +- [@angular-material-extensions/contacts](https://github.com/angular-material-extensions/contacts) |
| 58 | +- [@angular-material-extensions/faq](https://github.com/angular-material-extensions/faq) |
| 59 | +- [@angular-material-extensions/combination-generator](https://github.com/angular-material-extensions/combination-generator) |
28 | 60 |
|
29 | 61 | --- |
30 | | -##### SystemJS |
31 | | ->**Note**:If you are using `SystemJS`, you should adjust your configuration to point to the UMD bundle. |
32 | | -In your systemjs config file, `map` needs to tell the System loader where to look for `core`: |
33 | | -```js |
34 | | -map: { |
35 | | - 'core': 'node_modules/core/bundles/core.umd.js', |
36 | | -} |
37 | | -``` |
38 | | ---- |
39 | | - |
40 | | -Once installed you need to import the main module: |
41 | | -```js |
42 | | -import { LibModule } from 'core'; |
43 | | -``` |
44 | | -The only remaining part is to list the imported module in your application module. The exact method will be slightly |
45 | | -different for the root (top-level) module for which you should end up with the code similar to (notice ` LibModule .forRoot()`): |
46 | | -```js |
47 | | -import { LibModule } from 'core'; |
48 | | - |
49 | | -@NgModule({ |
50 | | - declarations: [AppComponent, ...], |
51 | | - imports: [LibModule.forRoot(), ...], |
52 | | - bootstrap: [AppComponent] |
53 | | -}) |
54 | | -export class AppModule { |
55 | | -} |
56 | | -``` |
57 | 62 |
|
58 | | -Other modules in your application can simply import ` LibModule `: |
| 63 | +<a name="support"/> |
59 | 64 |
|
60 | | -```js |
61 | | -import { LibModule } from 'core'; |
| 65 | +## Support |
| 66 | ++ Drop an email to: [Anthony Nahas](mailto:anthony.na@hotmail.de) |
| 67 | ++ or open an appropriate [issue](https://github.com/angular-material-extensions/password-strength/issues) |
| 68 | ++ let us chat on [Gitter](https://gitter.im/angular-material-extensions/Lobby) |
| 69 | + |
| 70 | + Built by and for developers :heart: we will help you :punch: |
62 | 71 |
|
63 | | -@NgModule({ |
64 | | - declarations: [OtherComponent, ...], |
65 | | - imports: [LibModule, ...], |
66 | | -}) |
67 | | -export class OtherModule { |
68 | | -} |
69 | | -``` |
| 72 | +--- |
70 | 73 |
|
71 | | -## Usage |
| 74 | + |
72 | 75 |
|
| 76 | +This project is supported by [jetbrains](https://www.jetbrains.com/) with 1 ALL PRODUCTS PACK OS LICENSE incl. [webstorm](https://www.jetbrains.com/webstorm) |
73 | 77 |
|
| 78 | +--- |
74 | 79 |
|
75 | 80 | ## License |
76 | 81 |
|
|
0 commit comments