Skip to content

Commit 40ea98f

Browse files
committed
Tweak README ready for v3 release
1 parent 0d3434f commit 40ea98f

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

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

8-
> Official support for Hooks was added to React Native in v0.59.0. React Firebase Hooks works with both the Firebase JS SDK and React Native Firebase, although some of the Flow and Typescript typings may be incorrect - we are investigating ways to improve this for React Native Firebase users.
9-
10-
**This documentation is for v2 of React Firebase Hooks which involved a number of breaking changes, including switching from `Object` to `Array` returns - more details [here](https://github.com/CSFrequency/react-firebase-hooks/releases/tag/v2.0.0). For v1 documentation, see [here](https://github.com/CSFrequency/react-firebase-hooks/tree/v1.2.1).**
8+
**This documentation is for v3 of React Firebase Hooks which involved a number of breaking changes, including adding support for Firebase v8.0.0 - more details [here](https://github.com/CSFrequency/react-firebase-hooks/releases/tag/v3.0.0). For v2 documentation, see [here](https://github.com/CSFrequency/react-firebase-hooks/tree/v2.2.0).**
119

1210
## Installation
1311

14-
React Firebase Hooks requires **React 16.8.0 or later** and **Firebase v5.0.0 or later**.
12+
React Firebase Hooks v3 requires **React 16.8.0 or later** and **Firebase v8.0.0 or later**.
13+
14+
> Official support for Hooks was added to React Native in v0.59.0. React Firebase Hooks works with both the Firebase JS SDK and React Native Firebase, although some of the typings may be incorrect.
1515
1616
```
1717
npm install --save react-firebase-hooks
@@ -25,11 +25,9 @@ There has been a **lot** of hype around React Hooks, but this hype merely reflec
2525

2626
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.
2727

28-
## Upgrading from v1 to v2
29-
30-
After feedback on the initial release of React Firebase Hooks, we opted to change from `Object` to `Array` returns to allow for easier composition of hooks in v2.
28+
## Upgrading from v2 to v3
3129

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

3432
## Documentation
3533

0 commit comments

Comments
 (0)