add Installation section to readme

coder-xiaotian · Jul 8, 2023 · 3576523 · 3576523
1 parent 5802171
commit 3576523
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/README-ZH.md b/README-ZH.md
@@ -3,6 +3,22 @@
 
 一个将React组件库自动转换为“React客户端组件“的 swc 插件，比如：你可以通过它自动将@mui中的组件自动转换为"React客户端组件"，而不用在外部包装一个使用了"use client"的组件。
 
+## 安装
+npm: 
+```
+npm install -D use-client
+```
+
+yarn:
+```
+yarn add -D use-client
+```
+
+pnpm:
+```
+pnpm i -D use-client
+```
+
 ## 配置
 + include：["@mui/material"]
 

diff --git a/README.md b/README.md
@@ -3,6 +3,22 @@
 
 A swc plugin that automatically converts React component libraries into "React Client Component". For example, you can automatically convert components from @mui into "React Client Component" without having to wrap a component that uses "use client".
 
+## Installation
+npm: 
+```
+npm install -D use-client
+```
+
+yarn:
+```
+yarn add -D use-client
+```
+
+pnpm:
+```
+pnpm i -D use-client
+```
+
 ## Configuration
 + include: ["@mui/material"]