Skip to content

Commit e974860

Browse files
committed
More README tweaks
1 parent 003e2be commit e974860

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ A set of reusable [React Hooks](https://reactjs.org/docs/hooks-intro.html) for [
1414
React Firebase Hooks requires **React 16.8.0 or later** and **Firebase v5.0.0 or later**.
1515

1616
```
17-
npm install --save react-firebase-hooks@1.2.1
17+
npm install --save react-firebase-hooks
1818
```
1919

2020
This assumes that you’re using the [npm](https://npmjs.com) package manager with a module bundler like [Webpack](https://webpack.js.org/) or [Browserify](http://browserify.org/) to consume [CommonJS](http://webpack.github.io/docs/commonjs.html) modules.
@@ -25,6 +25,12 @@ 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.
31+
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.
33+
2834
## Documentation
2935

3036
- [Auth Hooks](/auth)

0 commit comments

Comments
 (0)