Skip to content

Commit

Permalink
docs: Complete description of the '@netless/appliance-plugin' install…
Browse files Browse the repository at this point in the history
…ation scenario
  • Loading branch information
hqer927 committed Nov 15, 2024
1 parent 72083e2 commit e37c95c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 8 deletions.
16 changes: 12 additions & 4 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
<pre class="language-bash">
npm add <b>@netless/fastboard</b> @netless/window-manager white-web-sdk @netless/appliance-plugin
</pre>

> **注意:** `@netless/appliance-plugin` 是开启 [性能优化版本](#performance) 才需要安装。
#### 全打包方式引用
Expand Down Expand Up @@ -119,18 +120,25 @@ main().catch(console.error);

先安装 @netless/fastboard-react,再使用里面提供的 `<Fastboard />` 组件。

#### 全打包方式引用
#### 分包方式引用

<pre class="language-bash">
npm add <b>@netless/fastboard-react</b> react react-dom
npm add <b>@netless/fastboard-react</b> @netless/window-manager white-web-sdk react react-dom @netless/appliance-plugin
</pre>

#### 分包方式引用
> **注意:** `@netless/appliance-plugin` 是开启 [性能优化版本](#performance) 才需要安装。
#### 全打包方式引用

<pre class="language-bash">
npm add <b>@netless/fastboard-react</b> @netless/window-manager white-web-sdk react react-dom @netless/appliance-plugin
npm add <b>@netless/fastboard-react</b> react react-dom @netless/appliance-plugin
</pre>

> **注意:** 全打包方式引用,则 `@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";
Expand Down
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,19 +112,25 @@ main().catch(console.error);

Install `@netless/fastboard-react`, use the `<Fastboard />` component.

#### Full package
#### Subcontracting package

<pre class="language-bash">
npm add <b>@netless/fastboard-react</b> react react-dom
npm add <b>@netless/fastboard-react</b> @netless/window-manager white-web-sdk react react-dom @netless/appliance-plugin
</pre>

> **注意:** The `@netless/appliance-plugin` needs to be installed only when [Use performance](#performance) is enabled.
#### Subcontracting package

#### Full package

<pre class="language-bash">
npm add <b>@netless/fastboard-react</b> @netless/window-manager white-web-sdk react react-dom @netless/appliance-plugin
npm add <b>@netless/fastboard-react</b> react react-dom @netless/appliance-plugin
</pre>

> **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";
Expand Down

0 comments on commit e37c95c

Please sign in to comment.