Skip to content

Commit f26e1b3

Browse files
committed
docs(project): updated the readme
1 parent 854f5bc commit f26e1b3

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
Do you have any question or suggestion ? Please do not hesitate to contact us!
2626
Alternatively, provide a PR | open an appropriate issue [here](https://github.com/angular-material-extensions/faq/issues)
2727

28-
If did you like this project, support [angular-material-extensions](https://github.com/angular-material-extensions)
28+
If you like this project, support [angular-material-extensions](https://github.com/angular-material-extensions)
2929
by starring :star: and sharing it :loudspeaker:
3030

3131
## Table of Contents
@@ -58,10 +58,10 @@ View all the directives and components in action at [https://angular-material-ex
5858

5959
### Requirements (peer dependencies):
6060
- [angular flex-layout v6.0.0-beta.16](https://www.npmjs.com/package/@angular/flex-layout)
61-
- [angular material v6.2.1](https://www.npmjs.com/package/@angular/material)
62-
- [angular cdk v6.0.2](https://www.npmjs.com/package/@angular/cdk)
63-
- [angular animations v6.0.5](https://www.npmjs.com/package/@angular/animations)
64-
- [angular forms v6.0.5](https://www.npmjs.com/package/@angular/forms)
61+
- [angular material v6.4.0](https://www.npmjs.com/package/@angular/material)
62+
- [angular cdk v6.4.0](https://www.npmjs.com/package/@angular/cdk)
63+
- [angular animations v6.0.9](https://www.npmjs.com/package/@angular/animations)
64+
- [angular forms v6.0.9](https://www.npmjs.com/package/@angular/forms)
6565

6666
```bash
6767
npm i @angular/cdk @angular/material @angular/flex-layout @angular/animations @angular/forms
@@ -153,9 +153,13 @@ import { MatFaqModule } from '@angular-material-extensions/faq';
153153
export class OtherModule {
154154
}
155155
```
156+
156157
<a name="usage"/>
157158

158-
## (2) [Usage](https://angular-material-extensions.github.io/faq/getting-started)
159+
## [Usage](https://angular-material-extensions.github.io/faq/getting-started)
160+
161+
162+
angular-material-extensions
159163

160164
add the `mat-faq` or the `mat-faq-admin` element to your template:
161165

@@ -231,6 +235,7 @@ export class HomeComponent implements OnInit {
231235

232236
}
233237
```
238+
234239
<a name="documentation"/>
235240

236241
## [Documentation](https://angular-material-extensions.github.io/faq/doc/index.html)
@@ -244,7 +249,7 @@ or follow the official [tutorial](https://angular-material-extensions.github.io/
244249

245250
- [clone this repo](https://github.com/angular-material-extensions/faq.git) by running
246251
```bash
247-
$ git clone https://github.com/angular-material-extensions/faq.gi
252+
$ git clone https://github.com/angular-material-extensions/faq.git
248253
```
249254

250255
- link the **@angular-material-extensions/faq** package
@@ -316,15 +321,22 @@ To lint all `*.ts` files:
316321
```bash
317322
$ npm run lint
318323
```
324+
325+
---
326+
319327
<a name="other-angular-libraries"/>
320328

321329
## Other Angular Libraries
322330
- [ngx-auth-firebaseui](https://github.com/AnthonyNahas/ngx-auth-firebaseui)
323-
- [ngx-material-pages](https://github.com/AnthonyNahas/ngx-material-pages)
331+
- [@angular-material-extensions/pages](https://github.com/angular-material-extensions/pages)
324332
- [@angular-material-extensions/password-strength](https://github.com/angular-material-extensions/password-strength)
333+
- [@angular-material-extensions/google-maps-autocomplete](https://github.com/angular-material-extensions/google-maps-autocomplete)
334+
- [@angular-material-extensions/jumbotron](https://github.com/angular-material-extensions/jumbotron)
325335
- [@angular-material-extensions/contacts](https://github.com/angular-material-extensions/contacts)
326336
- [@angular-material-extensions/combination-generator](https://github.com/angular-material-extensions/combination-generator)
327337

338+
---
339+
328340
<a name="support"/>
329341

330342
## Support
@@ -334,6 +346,7 @@ $ npm run lint
334346

335347
Built by and for developers :heart: we will help you :punch:
336348

349+
---
337350

338351
## License
339352

0 commit comments

Comments
 (0)