Skip to content
This repository was archived by the owner on Dec 30, 2022. It is now read-only.

Commit ff72a02

Browse files
authored
docs(readme): add note for usage on -hooks and -hooks-web (#3651)
<!-- Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. --> **Summary** <!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? Are there any linked issues? --> Adds a two-way clarification in the readme of React InstantSearch hooks and React InstantSearch hooks web to explain what each package is used for. **Result** <!-- Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. --> fixes https://github.com/algolia/react-instantsearch/discussions/3610
1 parent dd5d311 commit ff72a02

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

packages/react-instantsearch-hooks-web/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ You should be using React InstantSearch Hooks Web if you want to:
1212
* Customize your components at will
1313
* Follow React principles
1414

15+
Note: If you are working with React Native, or otherwise do not use the DOM, check out `react-instantsearch-hooks` instead.
16+
1517
## Installation
1618

1719
React InstantSearch is available on the npm registry. It relies on [`algoliasearch`](https://github.com/algolia/algoliasearch-client-javascript) to communicate with Algolia APIs.

packages/react-instantsearch-hooks/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ InstantSearch’s goal is to help you implement awesome search experiences as sm
1010
</a>
1111
</p>
1212

13+
> Note: `react-instantsearch-hooks` exports renderless components and hooks which can be used for both web and React Native. If you are using React in a web project, we recommend using the package `react-instantsearch-hooks-web` instead, as it includes complete components that render to the DOM.
14+
1315
## Installation
1416

1517
React InstantSearch Hooks is available on the npm registry. It relies on [`algoliasearch`](https://github.com/algolia/algoliasearch-client-javascript) to communicate with Algolia APIs.

0 commit comments

Comments
 (0)