Skip to content

Commit 91ad0b7

Browse files
committed
docs(project): updated the readme.md in general
1 parent 7539363 commit 91ad0b7

File tree

6 files changed

+123
-50
lines changed

6 files changed

+123
-50
lines changed

README.md

Lines changed: 55 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,81 @@
11
<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">
35
</p>
46

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
68

7-
[![npm version](https://badge.fury.io/js/core.svg)](https://badge.fury.io/js/core),
9+
[![npm version](https://badge.fury.io/js/%40angular-material-extensions%2Fcore.svg)](https://badge.fury.io/js/%40angular-material-extensions%2Fcore)
10+
[![npm demo](https://img.shields.io/badge/demo-online-ed1c46.svg)](https://angular-material-extensions.github.io/core)
11+
[![docs: typedoc](https://img.shields.io/badge/docs-typedoc-4D0080.svg)](https://angular-material-extensions.github.io/core/doc/index.html)
12+
[![Join the chat at https://gitter.im/angular-material-extensions/Lobby](https://badges.gitter.im/angular-material-extensions/Lobby.svg)](https://gitter.im/angular-material-extensions/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
13+
[![CircleCI branch](https://img.shields.io/circleci/project/github/angular-material-extensions/core/master.svg?label=circleci)](https://circleci.com/gh/angular-material-extensions/core)
814
[![Build Status](https://travis-ci.org/angular-material-extensions/core.svg?branch=master)](https://travis-ci.org/angular-material-extensions/core)
9-
[![Coverage Status](https://coveralls.io/repos/github/angular-material-extensions/core/badge.svg?branch=master)](https://coveralls.io/github/angular-material-extensions/core?branch=master)
15+
[![codecov](https://codecov.io/gh/angular-material-extensions/core/branch/master/graph/badge.svg)](https://codecov.io/gh/angular-material-extensions/core)
1016
[![dependency Status](https://david-dm.org/angular-material-extensions/core/status.svg)](https://david-dm.org/angular-material-extensions/core)
1117
[![devDependency Status](https://david-dm.org/angular-material-extensions/core/dev-status.svg?branch=master)](https://david-dm.org/angular-material-extensions/core#info=devDependencies)
1218
[![Greenkeeper Badge](https://badges.greenkeeper.io/angular-material-extensions/core.svg)](https://greenkeeper.io/)
19+
[![license](https://img.shields.io/github/license/angular-material-extensions/core.svg?style=flat-square)](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)
1342

1443
## Demo
1544

1645
View all the directives in action at https://angular-material-extensions.github.io/core
1746

18-
## Dependencies
19-
* [Angular](https://angular.io) (*requires* Angular 2 or higher, tested with 2.0.0)
2047

21-
## Installation
22-
Install above dependencies via *npm*.
2348

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)
2860

2961
---
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-
```
5762

58-
Other modules in your application can simply import ` LibModule `:
63+
<a name="support"/>
5964

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:
6271

63-
@NgModule({
64-
declarations: [OtherComponent, ...],
65-
imports: [LibModule, ...],
66-
})
67-
export class OtherModule {
68-
}
69-
```
72+
---
7073

71-
## Usage
74+
![jetbrains logo](https://raw.githubusercontent.com/angular-material-extensions/password-strength/HEAD/assets/jetbrains-variant-4_logos/jetbrains-variant-4.png)
7275

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)
7377

78+
---
7479

7580
## License
7681

49 KB
Loading
Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
DO’s
2+
----
3+
4+
* Do use the logos to link to JetBrains website: https://www.jetbrains.com
5+
* Do use the logos to advertise that your product has built-in integration with a JetBrains product
6+
* Do use the graphics in printed or online materials, but respect the minimum size of the logo: 7.5mm in print and 50px on screen/digital.
7+
8+
9+
Don’ts
10+
------
11+
12+
* Don’t change the colors of the logos
13+
* Don’t change the aspect ratio of the logos when resizing
14+
* Don’t crop the logos
15+
* Don’t use the black square without the beam or the product name
16+
* Don’t add any text on the logo
17+
* Don’t sell our logos
18+
19+
If in doubt, please contact marketing@jetbrains.com
20+
21+
--
22+
23+
Thank you!
24+
The JetBrains Team
122 KB
Loading
Lines changed: 43 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)