Skip to content

Commit fe63d8a

Browse files
committed
chore: readme update
1 parent 3195672 commit fe63d8a

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
| ------------ | --------------------------------------------- | ----------------------------------------------- |
2424
| Ely Lucas | [elylucas](https://github.com/elylucas) | [@elylucas](https://twitter.com/elylucas) |
2525

26+
> These docs are for Capacitor 3 plugins. For docs that target v2 plugins, see the [capv2](https://github.com/capacitor-community/react-hooks/tree/capv2) branch.
2627
## Getting Started
2728

2829
To start using Capacitor Hooks in your app, you install the React Hook package along with the Capacitor plugin you want to use. Here is an example of using the Storage plugin along with it's React hook:
@@ -34,7 +35,7 @@ npm install @capacitor/storage
3435
npm install @capacitor-community/react-storage
3536
```
3637

37-
Import the hooks:\
38+
Import the hooks:
3839
```jsx
3940
`import { useStorage } from '@capacitor-community/storage-react'`
4041
```
@@ -61,8 +62,6 @@ if(availableFeatures.useStorage) {
6162
}
6263
```
6364

64-
> These docs are for Capacitor 3 plugins. For docs that target v2 plugins, see the [capv2](https://github.com/capacitor-community/react-hooks/tree/capv2) branch.
65-
6665
# Upgrading from Capacitor 2 React Hooks
6766

6867
In Capacitor 3, all the plugins were separated into their own packages. Likewise, the new React hooks plugins were also put into their own package, so you will need to install the hook for each plugin you use.

0 commit comments

Comments
 (0)