Skip to content

Commit 2fe75a5

Browse files
authored
Updated README after new release. (#76)
- Updated CDN links. - Added NPM and Bower installation instructions.
1 parent 0cc8395 commit 2fe75a5

File tree

3 files changed

+48
-9
lines changed

3 files changed

+48
-9
lines changed

README.md

Lines changed: 46 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,54 @@ Ionic...) nor Chrome extensions.
3434

3535
## Installation
3636

37+
### CDN
38+
3739
You just need to include the following script and CSS file in the `<head>` tag of your page,
3840
below the initialization snippet from the Firebase Console:
3941

4042
```html
41-
<script src="https://www.gstatic.com/firebasejs/ui/live/1.0/firebase-ui-auth.js"></script>
42-
<link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/live/1.0/firebase-ui-auth.css" />
43+
<script src="https://cdn.firebase.com/libs/firebaseui/1.0.0/firebaseui.js"></script>
44+
<link type="text/css" rel="stylesheet" href="https://cdn.firebase.com/libs/firebaseui/1.0.0/firebaseui.css" />
45+
```
46+
47+
### npm Module
48+
49+
Install FirebaseUI and its dependencies via npm using the following command:
50+
51+
```bash
52+
$ npm install firebaseui --save
53+
```
54+
55+
You can then `require` the following modules within your source files:
56+
57+
```javascript
58+
var firebase = require('firebase');
59+
var firebaseui = require('firebaseui');
60+
```
61+
62+
Or include the required files in your HTML, if your HTTP Server serves the files
63+
within `node_modules/`:
64+
65+
```html
66+
<script src="node_modules/firebaseui/dist/firebaseui.js"></script>
67+
<link type="text/css" rel="stylesheet" href="node_modules/firebaseui/dist/firebaseui.css" />
4368
```
4469

45-
You can then serve your app locally using `firebase serve`.
70+
### Bower component
71+
72+
Install FirebaseUI and its dependencies via Bower using the following command:
73+
74+
```bash
75+
$ bower install firebaseui --save
76+
```
77+
78+
You can then include the required files in your HTML, if your HTTP Server serves the files
79+
within `bower_components/`:
80+
81+
```html
82+
<script src="bower_components/firebaseui/dist/firebaseui.js"></script>
83+
<link type="text/css" rel="stylesheet" href="bower_components/firebaseui/dist/firebaseui.css" />
84+
```
4685

4786
## Using FirebaseUI for Authentication
4887

@@ -94,8 +133,8 @@ example, showcasing a Single Page Application mode.
94133
* TODO(DEVELOPER): Paste the initialization snippet from:
95134
* Firebase Console > Overview > Add Firebase to your web app. *
96135
***************************************************************************************** -->
97-
<script src="https://www.gstatic.com/firebasejs/ui/live/1.0/firebase-ui-auth.js"></script>
98-
<link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/live/1.0/firebase-ui-auth.css" />
136+
<script src="https://cdn.firebase.com/libs/firebaseui/1.0.0/firebaseui.js"></script>
137+
<link type="text/css" rel="stylesheet" href="https://cdn.firebase.com/libs/firebaseui/1.0.0/firebaseui.css" />
99138
<script type="text/javascript">
100139
// FirebaseUI config.
101140
var uiConfig = {
@@ -305,8 +344,8 @@ If the callback returns `false` or nothing, the page is not automatically redire
305344
* TODO(DEVELOPER): Paste the initialization snippet from:
306345
* Firebase Console > Overview > Add Firebase to your web app. *
307346
***************************************************************************************** -->
308-
<script src="https://www.gstatic.com/firebasejs/ui/live/1.0/firebase-ui-auth.js"></script>
309-
<link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/live/1.0/firebase-ui-auth.css" />
347+
<script src="https://cdn.firebase.com/libs/firebaseui/1.0.0/firebaseui.js"></script>
348+
<link type="text/css" rel="stylesheet" href="https://cdn.firebase.com/libs/firebaseui/1.0.0/firebaseui.css" />
310349
<script type="text/javascript">
311350
// FirebaseUI config.
312351
var uiConfig = {

demo/public/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="UTF-8">
55
<title>FirebaseUI Auth Demo</title>
6-
<script src="https://www.gstatic.com/firebasejs/live/3.5/firebase.js"></script>
6+
<script src="https://www.gstatic.com/firebasejs/live/3.6/firebase.js"></script>
77
<script src="config.js"></script>
88
<link href="style.css" rel="stylesheet" type="text/css" media="screen" />
99
<script src="dist/firebaseui.js"></script>

demo/public/widget.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="UTF-8">
55
<title>FirebaseUI Auth Demo</title>
6-
<script src="https://www.gstatic.com/firebasejs/live/3.5/firebase.js"></script>
6+
<script src="https://www.gstatic.com/firebasejs/live/3.6/firebase.js"></script>
77
<script src="config.js"></script>
88
<script src="dist/firebaseui.js"></script>
99
<link type="text/css" rel="stylesheet" href="dist/firebaseui.css" />

0 commit comments

Comments
 (0)