diff --git a/README-zh.md b/README-zh.md index c0293b1..b8a6049 100644 --- a/README-zh.md +++ b/README-zh.md @@ -20,6 +20,7 @@
 npm add @netless/fastboard @netless/window-manager white-web-sdk @netless/appliance-plugin
 
+ > **注意:** `@netless/appliance-plugin` 是开启 [性能优化版本](#performance) 才需要安装。 #### 全打包方式引用 @@ -119,18 +120,25 @@ main().catch(console.error); 先安装 @netless/fastboard-react,再使用里面提供的 `` 组件。 -#### 全打包方式引用 +#### 分包方式引用
-npm add @netless/fastboard-react react react-dom
+npm add @netless/fastboard-react @netless/window-manager white-web-sdk react react-dom @netless/appliance-plugin
 
-#### 分包方式引用 +> **注意:** `@netless/appliance-plugin` 是开启 [性能优化版本](#performance) 才需要安装。 + +#### 全打包方式引用
-npm add @netless/fastboard-react @netless/window-manager white-web-sdk react react-dom @netless/appliance-plugin
+npm add @netless/fastboard-react react react-dom @netless/appliance-plugin
 
+> **注意:** 全打包方式引用,则 `@netless/window-manager`、`white-web-sdk` 可以不用安装。而 @netless/appliance-plugin 是开启[性能优化版本](#performance) 才需要安装。 +> +> `@netless/window-manager`、`white-web-sdk`、`@netless/appliance-plugin`、`react`、`react-dom` 是 peerDependency,如果你不清楚 peerDependency 是什么意思,可以阅读 [《为什么使用 peerDependency ?》](./docs/zh/peer-dependency.md)。 + + ```jsx // 全打包方式引用 import { useFastboard, Fastboard } from "@netless/fastboard-react/full"; diff --git a/README.md b/README.md index cc11f25..c957aae 100644 --- a/README.md +++ b/README.md @@ -112,19 +112,25 @@ main().catch(console.error); Install `@netless/fastboard-react`, use the `` component. -#### Full package +#### Subcontracting package
-npm add @netless/fastboard-react react react-dom
+npm add @netless/fastboard-react @netless/window-manager white-web-sdk react react-dom @netless/appliance-plugin
 
+> **注意:** The `@netless/appliance-plugin` needs to be installed only when [Use performance](#performance) is enabled. -#### Subcontracting package + +#### Full package
-npm add @netless/fastboard-react @netless/window-manager white-web-sdk react react-dom @netless/appliance-plugin
+npm add @netless/fastboard-react react react-dom @netless/appliance-plugin
 
+> **Note:** Full package reference, then `@netless/window-manager`, `white-web-sdk` can not be installed. The `@netless/appliance-plugin` needs to be installed only when [Use performance](#performance) is enabled. +> +> `@netless/window-manager`, `white-web-sdk`, `@netless/appliance-plugin` is peerDependency, if you're not sure what peerDependency means, You can read [Why Use peerDependency?](./docs/zh/peer-dependency.md) + ```jsx // Full package import { useFastboard, Fastboard } from "@netless/fastboard-react/full";