Skip to content

Commit 2885194

Browse files
committed
Update README
1 parent 5f2a167 commit 2885194

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# React Firebase Hooks
1+
# React Firebase Hooks (v2)
22

3-
A set of reusable React Hooks for [Firebase](https://firebase.google.com/).
3+
A set of reusable [React Hooks](https://reactjs.org/docs/hooks-intro.html) for [Firebase](https://firebase.google.com/).
44

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-
> [Hooks](https://reactjs.org/docs/hooks-intro.html) are a new feature that lets you use state and other React features without writing a class and are available in React v16.8.0 or later.
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.
99
10-
> 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 users.
10+
**This documentation is for v2 of React Firebase Hooks which is currently at the Release Candidate stage for testing. For v1 documentation, click [here](https://github.com/CSFrequency/react-firebase-hooks/tree/v1.2.1).**
1111

1212
## Installation
1313

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
17+
npm install --save react-firebase-hooks@next
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.

0 commit comments

Comments
 (0)