Skip to content

Commit a5a71d1

Browse files
improve doc
1 parent 256c6e7 commit a5a71d1

File tree

6 files changed

+437
-79
lines changed

6 files changed

+437
-79
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,13 @@ a React/Vue component to show the `git diff`/`file diff` result, just like Githu
5555
```shell
5656
# In React Project
5757
pnpm add @git-diff-view/react
58+
# full type need install
59+
pnpm add -D @git-diff-view/core
5860

5961
# In Vue Project
6062
pnpm add @git-diff-view/vue
63+
# full type need install
64+
pnpm add -D @git-diff-view/core
6165

6266
```
6367

packages/react/package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,13 @@
7272
"tailwindcss": "^3.4.3"
7373
},
7474
"peerDependencies": {
75+
"@git-diff-view/core": "latest",
7576
"react": "^16.8.0 || ^17.0.0 || ^18.0.0",
7677
"react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
78+
},
79+
"peerDependenciesMeta": {
80+
"@git-diff-view/core": {
81+
"optional": true
82+
}
7783
}
7884
}

packages/vue/package.json

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,18 @@
6060
"postcss": "^8.4.38",
6161
"tailwind-scrollbar-hide": "^1.1.7",
6262
"tailwindcss": "^3.4.3",
63-
"vite": "^5.1.4",
64-
"vite-plugin-dts": "^3.7.3",
63+
"vite": "^5.2.11",
64+
"vite-plugin-dts": "^3.9.1",
6565
"vue": "^3.4.20",
6666
"vue-tsc": "^1.8.27"
6767
},
6868
"peerDependencies": {
69+
"@git-diff-view/core": "latest",
6970
"vue": "^3"
71+
},
72+
"peerDependenciesMeta": {
73+
"@git-diff-view/core": {
74+
"optional": true
75+
}
7076
}
7177
}

0 commit comments

Comments
 (0)