docs: update README (#202)

DevCloudFE · Feb 21, 2022 · 737948a · 737948a
1 parent 12c2d7b
commit 737948a
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 34 deletions.
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
@@ -15,17 +15,27 @@ jobs:
       matrix:
         node-version: [16.x]
 
+    name: "Build: node-${{ matrix.node-version }}"
     steps:
-    - uses: actions/checkout@v2
-    - name: Install pnpm
-    uses: pnpm/action-setup@v2
-    with:
-      version: 6
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'pnpm'
-    - run: pnpm i
-    - run: pnpm build
-    # - run: yarn test
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 6
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+
+      - name: Install deps
+        run: pnpm i
+
+      - name: Build site
+        run: pnpm build
+
+      # - name: Test vue-devui
+      #   run: yarn test
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+enable-pre-post-scripts=true
diff --git a/README.md b/README.md
@@ -25,21 +25,13 @@ DevUI 官方网站：[https://devui.design](https://devui.design)
 ### 1 安装依赖
 
 ```
-yarn(推荐)
-
-or
-
-npm i
+pnpm i
 ```
 
 ### 2 启动
 
 ```
-yarn dev(推荐)
-
-or
-
-npm run dev
+pnpm dev
 ```
 
 ### 3 访问
@@ -49,19 +41,15 @@ npm run dev
 ### 4 生产打包
 
 ```
-yarn build(推荐)
-
-or
-
-npm run build
+pnpm build
 ```
 
 ## 使用 Vue DevUI
 
 ### 1. 安装
 
 ```
-yarn add vue-devui
+pnpm i vue-devui
 ```
 
 ### 2. 全量引入
@@ -143,11 +131,7 @@ export default defineConfig({
 #### 安装
 
 ```
-yarn add @devui-design/icons(推荐)
-
-or
-
-npm i @devui-design/icons
+pnpm i @devui-design/icons
 ```
 
 #### 引入