Skip to content

Commit 182f5d8

Browse files
committed
docs(project): updated the readme
1 parent cff9fda commit 182f5d8

File tree

6 files changed

+91
-37
lines changed

6 files changed

+91
-37
lines changed

README.md

Lines changed: 20 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
[![npm demo](https://img.shields.io/badge/demo-online-ed1c46.svg)](https://angular-material-extensions.github.io/password-strength)
1111
[![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)
1212
[![CircleCI branch](https://img.shields.io/circleci/project/github/angular-material-extensions/password-strength/master.svg?label=circleci)](https://circleci.com/gh/angular-material-extensions/password-strength)
13+
[![Build Status](https://travis-ci.org/angular-material-extensions/password-strength.svg?branch=master)](https://travis-ci.org/angular-material-extensions/password-strength)
1314
[![codecov](https://codecov.io/gh/angular-material-extensions/password-strength/branch/master/graph/badge.svg)](https://codecov.io/gh/angular-material-extensions/password-strength)
1415
[![dependency Status](https://david-dm.org/angular-material-extensions/password-strength/status.svg)](https://david-dm.org/angular-material-extensions/password-strength)
1516
[![devDependency Status](https://david-dm.org/angular-material-extensions/password-strength/dev-status.svg?branch=master)](https://david-dm.org/angular-material-extensions/password-strength#info=devDependencies)
@@ -19,13 +20,8 @@
1920
> This project has been transferred from [ngx-material-password-strength](https://www.npmjs.com/package/ngx-material-password-strength) to [@angular-material-extensions/password-strength](https://github.com/angular-material-extensions/password-strength)
2021
2122
<p align="center">
22-
<img alt="@angular-material-extensions/password-strength" style="text-align: center;"
23-
src="https://raw.githubusercontent.com/angular-material-extensions/password-strength/HEAD/assets/demo_v2.0.1_2.gif">
24-
</p>
25-
26-
<p align="center">
27-
<img alt="@angular-material-extensions/password-strength" style="text-align: center;"
28-
src="https://raw.githubusercontent.com/angular-material-extensions/password-strength/HEAD/assets/demo_v2.0.1.gif">
23+
<img alt="@angular-material-extensions/password-strength demonstration" style="text-align: center;"
24+
src="https://raw.githubusercontent.com/angular-material-extensions/password-strength/HEAD/assets/v3.2.0/demo.gif">
2925
</p>
3026

3127
## Built by and for developers :heart:
@@ -63,21 +59,21 @@ View all the directives and components in action at [https://angular-material-ex
6359
## Library's components
6460
- `<mat-password-strength>` used to calculate and display the strength of a provided password
6561

66-
1. strength score less than 20%
62+
1. strength score <= 20%
6763

6864
<p align="center">
6965
<img alt="@angular-material-extensions/password-strength score less than 20%" style="text-align: center;"
7066
src="https://raw.githubusercontent.com/angular-material-extensions/password-strength/HEAD/assets/v2.1.0/scrore_lesst_than_20.png">
7167
</p>
7268

73-
2. strength score less than 40%
69+
2. strength score <= 80%
7470

7571
<p align="center">
7672
<img alt="@angular-material-extensions/password-strength score less than 40%" style="text-align: center;"
7773
src="https://raw.githubusercontent.com/angular-material-extensions/password-strength/HEAD/assets/v2.1.0/scrore_lesst_than_40.png">
7874
</p>
7975

80-
1. strength score less than 100%
76+
1. strength score > 80%
8177

8278
<p align="center">
8379
<img alt="@angular-material-extensions/password-strength score less than 100%" style="text-align: center;"
@@ -96,18 +92,20 @@ View all the directives and components in action at [https://angular-material-ex
9692
<a name="dependencies"/>
9793

9894
## Dependencies
99-
* [Angular](https://angular.io) (*requires* Angular 2 or higher) developed and tested with `6.0.5`
95+
* [Angular](https://angular.io) developed and tested with `6.1.7`
10096

10197
---
10298

10399
<a name="peerDependencies"/>
104100

105101
## Requirements (peer dependencies):
106-
- [angular animations v6.1.0](https://www.npmjs.com/package/@angular/animations)
107-
- [angular forms v6.1.0](https://www.npmjs.com/package/@angular/forms)
108-
- [angular cdk v6.4.2](https://www.npmjs.com/package/@angular/cdk)
109-
- [angular material v6.4.2](https://www.npmjs.com/package/@angular/material)
102+
- [angular animations v6.1.7](https://www.npmjs.com/package/@angular/animations)
103+
- [angular forms v6.1.7](https://www.npmjs.com/package/@angular/forms)
104+
- [angular cdk v6.4.7](https://www.npmjs.com/package/@angular/cdk)
105+
- [angular material v6.4.7](https://www.npmjs.com/package/@angular/material)
106+
110107
- [angular material theme](https://material.angular.io/guide/getting-started#step-4-include-a-theme)
108+
- [angular material icons](https://material.angular.io/guide/getting-started#step-6-optional-add-material-icons)
111109

112110
```bash
113111
npm i @angular/cdk @angular/material @angular/animations @angular/forms
@@ -408,28 +406,12 @@ $ ng serve --open
408406
1. clone this [repo](https://github.com/angular-material-extensions/password-strength.git)
409407
2. Install the dependencies by running `npm i`
410408
3. build the library `npm run build` or `gulp build`
411-
To generate all `*.js`, `*.d.ts` and `*.metadata.json` files:
412-
413-
```bash
414-
$ npm run build
415-
```
416-
417-
4. Link the library
418-
- on windows `gulp link` or locally `npx gulp link`
419-
- on mac/linux `sudo gulp link` or locally `sudo npx gulp link`
420-
409+
4. Link the library `gulp link`
421410
5. Navigate to the demo app's directory
422411
- `cd demo`
423412
_ `npm i`
424413
_ `npm start`
425414

426-
extras
427-
To lint all `*.ts` files:
428-
429-
```bash
430-
$ npm run lint
431-
```
432-
433415
<a name="other-angular-libraries"/>
434416

435417
## Other Angular Libraries
@@ -441,12 +423,10 @@ $ npm run lint
441423
- [@angular-material-extensions/pages](https://github.com/angular-material-extensions/pages)
442424
- [@angular-material-extensions/contacts](https://github.com/angular-material-extensions/contacts)
443425
- [@angular-material-extensions/faq](https://github.com/angular-material-extensions/faq)
444-
- [@angular-material-extensions/cards](https://github.com/angular-material-extensions/cards)
445426
- [@angular-material-extensions/combination-generator](https://github.com/angular-material-extensions/combination-generator)
446427

447428
---
448429

449-
450430
<a name="support"/>
451431

452432
## Support
@@ -458,6 +438,12 @@ $ npm run lint
458438

459439
---
460440

441+
![jetbrains logo](https://raw.githubusercontent.com/angular-material-extensions/password-strength/HEAD/assets/jetbrains-variant-4_logos/jetbrains-variant-4.png)
442+
443+
This project is supported by [jetbrains](https://www.jetbrains.com/) with 1 ALL PRODUCTS PACK OS LICENSE incl. [webstorm](https://www.jetbrains.com/webstorm)
444+
445+
---
446+
461447
<a name="license"/>
462448

463449
## License
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 [email protected]
20+
21+
--
22+
23+
Thank you!
24+
The JetBrains Team
122 KB
Loading
Lines changed: 43 additions & 0 deletions
Loading

assets/v3.2.0/demo.gif

7.69 MB
Loading

demo/src/index.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919
<meta name="twitter:creator" content="@anthonynahas">
2020
<!-- Twitter Summary card images must be at least 120x120px -->
2121
<meta name="twitter:image"
22-
content="https://anthonynahas.github.io/@angular-material-extensions/password-strength/assets/logo.svg">
22+
content="https://@angular-material-extensions.github.io/password-strength/assets/logo.svg">
2323

2424
<!-- Open Graph data -->
2525
<meta property="og:title" content="@angular-material-extensions/password-strength"/>
2626
<meta property="og:type" content="article"/>
27-
<meta property="og:url" content="https://anthonynahas.github.io/@angular-material-extensions/password-strength"/>
27+
<meta property="og:url" content="https://angular-material-extensions.github.io/password-strength"/>
2828
<meta property="og:image"
29-
content="https://anthonynahas.github.io/@angular-material-extensions/password-strength/assets/logo.svg"/>
29+
content="https://angular-material-extensions.github.io/password-strength/assets/logo.svg"/>
3030
<meta property="og:description"
3131
content="Material password strength meter to indicate how secure is the provided password"/>
3232
<meta property="og:site_name" content="@angular-material-extensions/password-strength"/>
@@ -69,6 +69,7 @@
6969

7070
<body>
7171
<app-root>Loading...</app-root>
72+
<noscript>Please enable JavaScript to continue using this application.</noscript>
7273
</body>
7374

7475
</html>

0 commit comments

Comments
 (0)