docs: update readme

jerrywu001 · Aug 4, 2022 · 55ac7c7 · 55ac7c7
1 parent a8652cc
commit 55ac7c7
Show file tree

Hide file tree

Showing 8 changed files with 1,586 additions and 1,232 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -23,10 +23,7 @@ jobs:
           registry-url: https://registry.npmjs.org/
 
       - name: Install
-        run: npm ci
-
-      - name: Remove react types
-        run: rm -rf node_modules/@types/react
+        run: npm i
 
       - name: Lint
         run: npm run lint
@@ -42,7 +39,7 @@ jobs:
           registry-url: https://registry.npmjs.org/
 
       - name: Install
-        run: npm ci
+        run: npm i
 
       - name: Stylelint
         run: npm run stylelint
@@ -58,10 +55,7 @@ jobs:
           registry-url: https://registry.npmjs.org/
 
       - name: Install
-        run: npm ci
-
-      - name: Remove react types
-        run: rm -rf node_modules/@types/react
+        run: npm i
 
       - name: Typecheck
         run: npm run typecheck
@@ -77,10 +71,7 @@ jobs:
           registry-url: https://registry.npmjs.org/
 
       - name: Install
-        run: npm ci
-
-      - name: Remove react types
-        run: rm -rf node_modules/@types/react
+        run: npm i
 
       - name: Unit Test
         run: npm run test
diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml
@@ -19,10 +19,7 @@ jobs:
         with:
           node-version: 16
 
-      - run: npm ci
-
-      - name: Remove react types
-        run: rm -rf node_modules/@types/react
+      - run: npm i
 
       - run: npm test
       - run: npm run lint

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -15,10 +15,7 @@ jobs:
         with:
           node-version: 16
 
-      - run: npm ci
-
-      - name: Remove react types
-        run: rm -rf node_modules/@types/react
+      - run: npm i
 
       - run: npm test
       - run: npm run lint
@@ -35,10 +32,7 @@ jobs:
           node-version: 16
 
       - name: Install
-        run: npm ci
-
-      - name: Remove react types
-        run: rm -rf node_modules/@types/react
+        run: npm i
 
       - name: Set registry
         run: |

diff --git a/.gitignore b/.gitignore
@@ -9,7 +9,7 @@ node_modules
 .idea/
 *.log
 /coverage
-# package-lock.json
+package-lock.json
 pnpm-lock.yaml
 yarn.lock
 

diff --git a/README.md b/README.md
@@ -101,10 +101,6 @@ app.use(SanpackPlugin());
 npm i
 
 npm run storybook
-
-# If .tsx file has a type error about JSX (The storybook relies on @types/react), Please delete the @types/react.
-
-# rm -rf node_modules/@types/react
 ```
 
 ## for nuxt3