docs(readme): add peer dependencies to install instructions #1209
Conversation
Haroenv
requested review from
a team,
dhayab and
sarahdayan
and removed request for
a team
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 7763564:
|
| yarn add @algolia/autocomplete-js | ||
| yarn add algoliasearch search-insights @algolia/autocomplete-js | ||
| # or | ||
| npm install @algolia/autocomplete-js | ||
| npm install algoliasearch search-insights @algolia/autocomplete-js |
There was a problem hiding this comment.
I'm not positive we should ask users to install algoliasearch and search-insights just to fix peer dependencies warnings, as they're not needed with third-party sources.
Maybe instead we could add a small "Troubleshooting" "FAQ" section in the Readme, to explain why we have those peer dependencies, something like:
Q: Why are there multiple peer dependencies warnings when I install autocomplete-js?
A: Autocomplete provides first-class support for Algolia sources and sending events. This means we rely on some packages that you might not need by default. These warnings can be safely ignored.
There was a problem hiding this comment.
maybe we should mark them as optional them? don't the typing need the packages to be installed?
Summary
Peer dependency warnings are given if you don't install those, so we should at least have them in the main install instructions.
Could also make sense to do it in a separate "before you start" instructions, but not sure if that is clearer or more confusing.
Result
fixes #1208