Skip to content

Commit ad70a12

Browse files
committed
docs(afs): format readme
1 parent 8bb3125 commit ad70a12

File tree

2 files changed

+30
-30
lines changed

2 files changed

+30
-30
lines changed

README.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
<p align="center">
2-
<h1 align="center">AngularFire2</h1>
3-
<p align="center">The official library for Firebase and Angular 2</p>
2+
<h1 align="center">AngularFire</h1>
3+
<p align="center">The official library for Firebase and Angular</p>
44
</p>
55

66
[![Build Status](https://travis-ci.org/angular/angularfire2.svg?branch=master)](https://travis-ci.org/angular/angularfire2) [![Join the chat at https://gitter.im/angular/angularfire2](https://badges.gitter.im/angular/angularfire2.svg)](https://gitter.im/angular/angularfire2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
77

88
Status: Release candidate
99

10-
## What is AngularFire2?
10+
## What is AngularFire?
1111

12-
- **Observable based** - Use the power of rxjs, Angular 2, and Firebase.
13-
- **Realtime bindings** - Synchronize database collections as objects or lists.
14-
- **Authentication** - Monitor authentication state in realtime.
12+
- **Observable based** - Use the power of RxJS, Angular, and Firebase.
13+
- **Realtime bindings** - Synchronize data in reatime.
14+
- **Authentication** - Log users in with a variety of providers and monitor authentication state in realtime.
15+
- **Offline Data** - Store data offline automatically with AngularFirestore.
16+
- **ngrx friendly** - Integrate with ngrx using AngularFire's action based APIs.
1517

1618
#### Quick links
1719
[Contributing](CONTRIBUTING.md)
@@ -30,7 +32,8 @@ npm install firebase angularfire2 --save
3032

3133
```ts
3234
import { Component } from '@angular/core';
33-
import { AngularFireDatabase, FirebaseListObservable } from 'angularfire2/database';
35+
import { AngularFirestore } from 'angularfire2/firestore';
36+
import { Observable } from 'rxjs/Observable';
3437

3538
@Component({
3639
selector: 'project-name-app',
@@ -43,36 +46,33 @@ import { AngularFireDatabase, FirebaseListObservable } from 'angularfire2/databa
4346
`
4447
})
4548
export class MyApp {
46-
items: FirebaseListObservable<any[]>;
47-
constructor(db: AngularFireDatabase) {
48-
this.items = db.list('/items');
49+
items: Observable<any[]>;
50+
constructor(db: AngularFirestore) {
51+
this.items = db.collection('items').valueChanges();
4952
}
5053
}
5154
```
5255

5356
## Developer Guide
54-
If you want to get started quickly on building with AngularFire2, check out our
55-
5 step developer guide that will teach you everything you need to know to be
56-
productive with AngularFire2.
5757

58-
## Getting started
59-
[Installation & Setup](docs/1-install-and-setup.md)
58+
### Getting started
59+
- [Installation & Setup](docs/1-install-and-setup.md)
6060

61-
## AngularFirestore
62-
[Using collections](docs/firestore/collections.md)
63-
[Using documents](docs/firestore/documents.md)
61+
### AngularFirestore
62+
- [Using collections](docs/firestore/collections.md)
63+
- [Using documents](docs/firestore/documents.md)
6464

65-
## AngularFireAuth
66-
[User Authentication](docs/5-user-authentication.md)
65+
### AngularFireAuth
66+
- [User Authentication](docs/5-user-authentication.md)
6767

68-
## AngularFireDatabase
69-
[Retrieving data as objects](docs/2-retrieving-data-as-objects.md)
70-
[Retrieving data as lists](docs/3-retrieving-data-as-lists.md)
71-
[Querying lists](docs/4-querying-lists.md)
68+
### AngularFireDatabase
69+
- [Retrieving data as objects](docs/2-retrieving-data-as-objects.md)
70+
- [Retrieving data as lists](docs/3-retrieving-data-as-lists.md)
71+
- [Querying lists](docs/4-querying-lists.md)
7272

73-
## Ionic
74-
[Using AngularFire2 with Ionic 2](docs/Auth-with-Ionic2.md)
75-
[Using AngularFire2 with Ionic 3 and Angular 4](docs/Auth-with-Ionic3-Angular4.md)
73+
### Ionic
74+
- [Using AngularFire with Ionic 2](docs/Auth-with-Ionic2.md)
75+
- [Using AngularFire with Ionic 3 and Angular 4](docs/Auth-with-Ionic3-Angular4.md)
7676

77-
## Deploying to Firebase Hosting
78-
[Deploying AngularFire to Firebase Hosting](docs/7-deploying-angularfire-to-firebase.md)
77+
### Deploy to Firebase Hosting
78+
- [Deploying AngularFire to Firebase Hosting](docs/7-deploying-angularfire-to-firebase.md)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "angularfire2",
3-
"version": "4.0.0-rc.3",
3+
"version": "5.0.0-rc.0",
44
"description": "The official library of Firebase and Angular.",
55
"private": true,
66
"scripts": {

0 commit comments

Comments
 (0)