Skip to content

Commit a0d78d6

Browse files
committed
docs: improve docs
1 parent db80c54 commit a0d78d6

File tree

5 files changed

+6
-10
lines changed

5 files changed

+6
-10
lines changed

README.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ A set of reusable [React Hooks](https://reactjs.org/docs/hooks-intro.html) for [
77
[![npm version](https://img.shields.io/npm/v/react-firebase-hooks.svg?style=flat-square)](https://www.npmjs.com/package/react-firebase-hooks)
88
[![npm downloads](https://img.shields.io/npm/dm/react-firebase-hooks.svg?style=flat-square)](https://www.npmjs.com/package/react-firebase-hooks)
99

10-
This documentation is for v4 of React Firebase Hooks which involved a number of breaking changes, including adding support for Firebase v9 - more details [here](https://github.com/CSFrequency/react-firebase-hooks/releases/tag/v4.0.0).
10+
This documentation is for v4 of React Firebase Hooks which makes the package compatible with Firebase v9 and drops support for previous versions of Firebase - more details [here](https://github.com/CSFrequency/react-firebase-hooks/releases/tag/v4.0.0).
11+
1112
- For v3 documentation (Firebase v8), see [here](https://github.com/CSFrequency/react-firebase-hooks/tree/v3.0.0).
1213
- For v2 documentation, see [here](https://github.com/CSFrequency/react-firebase-hooks/tree/v2.2.0).
1314

@@ -33,10 +34,6 @@ There has been a **lot** of hype around React Hooks, but this hype merely reflec
3334

3435
This library explores how React Hooks can work to make integration with Firebase even more straightforward than it already is. It takes inspiration for naming from RxFire and is based on an internal library that we had been using in a number of apps prior to the release of React Hooks. The implementation with hooks is 10x simpler than our previous implementation.
3536

36-
## Upgrading from v3 to v4
37-
38-
To upgrade your project from v3 to v4 check out the [Release Notes](https://github.com/CSFrequency/react-firebase-hooks/releases/tag/v4.0.0) which have full details of everything that needs to be changed.
39-
4037
## Upgrading from v2 to v3
4138

4239
To upgrade your project from v2 to v3 check out the [Release Notes](https://github.com/CSFrequency/react-firebase-hooks/releases/tag/v3.0.1) which have full details of everything that needs to be changed.

auth/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# React Firebase Hooks - Auth
22

3-
React Firebase Hooks provides a convenience listener for Firebase Auth's auth state. The hook wraps around the `auth.onAuthStateChange(auth.getAuth(firebaseApp))` method to ensure that it is always up to date.
3+
React Firebase Hooks provides a convenience listener for Firebase Auth's auth state. The hook wraps around the `auth.onAuthStateChange(...)` method to ensure that it is always up to date.
44

55
All hooks can be imported from `react-firebase-hooks/auth`, e.g.
66

database/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# React Firebase Hooks - Realtime Database
22

33
React Firebase Hooks provides convenience listeners for lists and values stored within the
4-
Firebase Realtime Database. The hooks wrap around the `onX(ref(firebase, 'path'), ...)` method.
4+
Firebase Realtime Database. The hooks wrap around the `onX(...)` method.
55

66
In addition to returning the list or value, the hooks provide an `error` and `loading` property
77
to give a complete lifecycle for loading and listening to the Realtime Database.

firestore/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# React Firebase Hooks - Cloud Firestore
22

3-
React Firebase Hooks provides convenience listeners for Collections and Documents stored with Cloud Firestore. The hooks wrap around the `onSnapshot(collection(...))`
4-
and `firestore.onSnapshot(firestore.doc(...))` methods.
3+
React Firebase Hooks provides convenience listeners for Collections and Documents stored with Cloud Firestore. The hooks wrap around the `firestore.onSnapshot(...)` method.
54

65
In addition to returning the snapshot value, the hooks provide an `error` and `loading` property
76
to give a complete lifecycle for loading and listening to Cloud Firestore.

storage/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# React Firebase Hooks - Cloud Storage
22

33
React Firebase Hooks provides convenience listeners for files stored within
4-
Firebase Cloud Storage. The hooks wrap around the `getDownloadURL(ref(storage, 'path/to/file'))` method.
4+
Firebase Cloud Storage. The hooks wrap around the `getDownloadURL(...)` method.
55

66
In addition to returning the download URL, the hooks provide an `error` and `loading` property
77
to give a complete lifecycle for loading from Cloud Storage.

0 commit comments

Comments
 (0)