Skip to content

Commit ddff485

Browse files
committed
docs(project): updated the readme
1 parent 81e4ce6 commit ddff485

File tree

1 file changed

+32
-28
lines changed

1 file changed

+32
-28
lines changed

README.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
[![npm demo](https://img.shields.io/badge/demo-online-ed1c46.svg)](https://firebaseui.github.io/ng-bootstrap)
1010
[![Join the chat at https://gitter.im/firebaseui/Lobby](https://badges.gitter.im/firebaseui/Lobby.svg)](https://gitter.im/firebaseui/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
1111
[![CircleCI branch](https://img.shields.io/circleci/project/github/firebaseui/ng-bootstrap/master.svg?label=circleci)](https://circleci.com/gh/firebaseui/ng-bootstrap)
12+
[![Build Status](https://travis-ci.org/firebaseui/ng-bootstrap.svg?branch=master)](https://travis-ci.org/firebaseui/ng-bootstrap)
1213
[![Coverage Status](https://coveralls.io/repos/github/firebaseui/ng-bootstrap/badge.svg?branch=master)](https://coveralls.io/github/firebaseui/ng-bootstrap?branch=master)
1314
[![dependency Status](https://david-dm.org/firebaseui/ng-bootstrap/status.svg)](https://david-dm.org/firebaseui/ng-bootstrap)
1415
[![devDependency Status](https://david-dm.org/firebaseui/ng-bootstrap/dev-status.svg?branch=master)](https://david-dm.org/firebaseui/ng-bootstrap#info=devDependencies)
@@ -62,13 +63,13 @@ If you prefer to develop with material design rather than with bootstrap, please
6263
| Sign Up | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
6364
| Sign In | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
6465
| Sign In Anonymously | :heavy_check_mark: | :heavy_check_mark: | :x: |
65-
| Sign In with Google | :soon: | :heavy_check_mark: | :heavy_check_mark: |
66-
| Sign In with Facebook | :soon: | :heavy_check_mark: | :heavy_check_mark: |
67-
| Sign In with Twitter | :soon: | :heavy_check_mark: | :heavy_check_mark: |
68-
| Sign In with Github | :soon: | :heavy_check_mark: | :heavy_check_mark: |
66+
| Sign In with Google | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
67+
| Sign In with Facebook | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
68+
| Sign In with Twitter | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
69+
| Sign In with Github | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
6970
| Sign In with PhoneNumber | :soon: | :x: | :heavy_check_mark: |
70-
| Sign out | :soon: | :heavy_check_mark: | :x: |
71-
| Sign in/up progress indicator | :heavy_check_mark: | :heavy_check_mark: | :x: |
71+
| Sign out | :heavy_check_mark: | :heavy_check_mark: | :x: |
72+
| Sign in/up progress indicator | :heavy_check_mark: | :heavy_check_mark: | :x: |
7273
| Password Strength indicator | :soon: | :heavy_check_mark: | :x: |
7374
| Forgot/Reset Password | :heavy_check_mark: | :heavy_check_mark: | :x: |
7475
| Delete account | :soon: | :heavy_check_mark: | :x: |
@@ -77,7 +78,7 @@ If you prefer to develop with material design rather than with bootstrap, please
7778
| Edit user's display name (incl. validation) | :soon: | :heavy_check_mark: | :x: |
7879
| Edit user's email (incl. validation) | :soon: | :heavy_check_mark: | :x: |
7980
| Edit user's phone number (incl. validation) | :soon: | :heavy_check_mark: | :x: |
80-
| Configure your favorite auth provider in runtime | :soon: | :heavy_check_mark: | :x: |
81+
| Configure your favorite auth provider in runtime | :heavy_check_mark: | :heavy_check_mark: | :x: |
8182
| Sync user'auth with Firestore [read more](FIRESTORE_SYNC.md) | :heavy_check_mark: | :heavy_check_mark: | :x: |
8283
| Angular v2-6 friendly | :heavy_check_mark: | :heavy_check_mark: | :x: |
8384
| Internationalization (i18n) | :soon: @angular v7 | :soon: @angular v7 | :heavy_check_mark: |
@@ -87,7 +88,7 @@ If you prefer to develop with material design rather than with bootstrap, please
8788
| Support Server Side Rendering | :heavy_check_mark: | :heavy_check_mark: | :x: |
8889
| Support SPA without further config | :heavy_check_mark: | :heavy_check_mark: | :x: |
8990
| Support Safari private browsing | :heavy_check_mark: | :heavy_check_mark: | :x: |
90-
| AWESOME | :heavy_check_mark: | :heavy_check_mark: | :interrobang: |
91+
| AWESOME | :soon: | :heavy_check_mark: | :interrobang: |
9192

9293

9394
<a name="@firebaseui/ng-bootstrap"/>
@@ -121,10 +122,10 @@ If you prefer to develop with material design rather than with bootstrap, please
121122
## Supported Providers:
122123
- anonymously
123124
- email and password (traditional)
124-
- google :soon:
125-
- facebook :soon:
126-
- twitter :soon:
127-
- github :soon:
125+
- google
126+
- facebook
127+
- twitter
128+
- github
128129
- phone number :soon:
129130

130131
<a name="supported-procress-and-actions"/>
@@ -135,20 +136,12 @@ If you prefer to develop with material design rather than with bootstrap, please
135136
- sign in Anonymously | with google, facebook, twitter, github
136137
- sign out
137138
- validation of password's strength while creating a new account using [ngb-material-password-strength](https://github.com/AnthonyNahas/ngb-material-password-strength) :soon:
138-
- forgot/reset password
139+
- forgot/reset password :soon:
139140
- sending email verifications
140141
- delete user's account :soon:
141142
- edit user's profile like email, name, (profile picture :soon:) and phone number :soon:
142143
- firestore auto sync :fire:
143144

144-
<a name="requirements"/>
145-
146-
### Requirements:
147-
- [ng-bootstrap - v2](https://www.npmjs.com/package/@ng-bootstrap/ng-bootstrap)
148-
- [angular forms - v6.x](https://www.npmjs.com/package/@angular/forms)
149-
- [angularfire2 - v5.0.0-rc.11](https://www.npmjs.com/package/angularfire2)
150-
- [firebase - v5.x](https://www.npmjs.com/package/firebase)
151-
- [font-awesome - v4.x](https://www.npmjs.com/package/font-awesome)
152145

153146
<a name="demo"/>
154147

@@ -162,7 +155,21 @@ if(issues || feedback || you_need_more_features){
162155
```
163156

164157
## Dependencies
165-
* [Angular](https://angular.io) (*requires* Angular 2 or higher, tested with v5 and v6)
158+
* [Angular](https://angular.io) (*requires*)
159+
160+
<a name="requirements"/>
161+
162+
### Requirements:
163+
- [bootstrap - v4](https://www.npmjs.com/package/bootstrap)
164+
- [ng-bootstrap - v2](https://www.npmjs.com/package/@ng-bootstrap/ng-bootstrap)
165+
- [angularfire2 - v5.0.0-rc.11](https://www.npmjs.com/package/angularfire2)
166+
- [firebase - v5.x](https://www.npmjs.com/package/firebase)
167+
- [font-awesome - v4.x](https://www.npmjs.com/package/font-awesome)
168+
- [angular forms - v6.x](https://www.npmjs.com/package/@angular/forms)
169+
170+
```shell
171+
npm install --save @ng-bootstrap/ng-bootstrap bootstrap angularfire2 firebase font-awesome @angular/forms
172+
```
166173

167174
## Installation
168175
Install above dependencies via *npm*.
@@ -362,24 +369,21 @@ To generate all `*.js`, `*.d.ts` and `*.metadata.json` files:
362369
$ npm run build
363370
```
364371

365-
To lint all `*.ts` files:
366-
367-
```bash
368-
$ npm run lint
369-
```
370372
---
371373

372374

373375
<a name="other-angular-libraries"/>
374376

375377
## Other Angular Libraries
376378
- [ngx-auth-firebaseui](https://github.com/AnthonyNahas/ngx-auth-firebaseui)
379+
- [ngx-linkifyjs](https://github.com/AnthonyNahas/ngx-linkifyjs)
377380
- [@angular-material-extensions/password-strength](https://github.com/angular-material-extensions/password-strength)
378381
- [@angular-material-extensions/pages](https://github.com/angular-material-extensions/pages)
382+
- [@angular-material-extensions/link-preview](https://github.com/angular-material-extensions/link-preview)
383+
- [@angular-material-extensions/google-maps-autocomplete](https://github.com/angular-material-extensions/google-maps-autocomplete)
379384
- [@angular-material-extensions/contacts](https://github.com/angular-material-extensions/contacts)
380385
- [@angular-material-extensions/faq](https://github.com/angular-material-extensions/faq)
381386
- [@angular-material-extensions/jumbotron](https://github.com/angular-material-extensions/jumbotron)
382-
- [@angular-material-extensions/google-maps-autocomplete](https://github.com/angular-material-extensions/google-maps-autocomplete)
383387
- [@angular-material-extensions/combination-generator](https://github.com/angular-material-extensions/combination-generator)
384388

385389
---

0 commit comments

Comments
 (0)