Skip to content

Commit f348541

Browse files
committed
docs: add note about npm peer dependencies
1 parent 5127e25 commit f348541

File tree

3 files changed

+608
-506
lines changed

3 files changed

+608
-506
lines changed

docs/install.mdx

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,17 @@ This package uses react-hooks and therefore will need
1919

2020
- Expo App - [Instructions](https://docs.expo.io/versions/latest/sdk/webview/)
2121

22-
2. Run - `npm install react-native-youtube-iframe`
22+
2. Install
23+
24+
:::info yarn - recommended
25+
26+
`yarn add react-native-youtube-iframe`
27+
:::
28+
29+
:::danger npm
30+
31+
`npm install react-native-youtube-iframe`
32+
33+
npm has some issues with peer dependencies where it tries to install all peer dependencies by default. If your project does not use react 17, it might case install failures. To get around this, use
34+
35+
`npm install react-native-youtube-iframe --legacy-peer-deps`

website/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
"build": "node generateIframe.js;docusaurus build"
1313
},
1414
"dependencies": {
15-
"@docusaurus/core": "^2.0.0-beta.0",
16-
"@docusaurus/preset-classic": "^2.0.0-beta.0",
15+
"@docusaurus/core": "^2.0.0-beta.3",
16+
"@docusaurus/preset-classic": "^2.0.0-beta.3",
1717
"@mdx-js/react": "^1.6.22",
1818
"clsx": "^1.1.1",
1919
"html-minifier": "^4.0.0",

0 commit comments

Comments
 (0)