Skip to content

Commit

Permalink
More README tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisbianca committed May 21, 2019
1 parent 003e2be commit e974860
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A set of reusable [React Hooks](https://reactjs.org/docs/hooks-intro.html) for [
React Firebase Hooks requires **React 16.8.0 or later** and **Firebase v5.0.0 or later**.

```
npm install --save react-firebase-hooks@1.2.1
npm install --save react-firebase-hooks
```

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.
Expand All @@ -25,6 +25,12 @@ There has been a **lot** of hype around React Hooks, but this hype merely reflec

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.

## Upgrading from v1 to v2

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.

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.

## Documentation

- [Auth Hooks](/auth)
Expand Down

0 comments on commit e974860

Please sign in to comment.