Skip to content

Commit 1750bf8

Browse files
committed
feat: update docs
1 parent 073af00 commit 1750bf8

File tree

3 files changed

+20
-12
lines changed

3 files changed

+20
-12
lines changed

docs/en/guide/getting-started.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,18 @@ pnpm install starter-lib-vue3
2323
<script src="https://unpkg.com/starter-lib-vue3"></script>
2424
```
2525

26-
It will be exposed to global as `window.StarterLibTs`
26+
It will be exposed to global as `window.StarterLibVue3`
2727

2828
## Usage Example
2929

30-
```js
31-
import { sayHello } from 'starter-lib-vue3'
30+
```vue
31+
<script setup>
32+
import { SayHello } from 'starter-lib-vue3'
33+
</script>
3234
33-
sayHello('Kieran')
35+
<template>
36+
<SayHello name="Kieran" />
37+
</template>
3438
```
3539

36-
Refer to [functions list](/functions/index) for more details.
40+
Refer to [component list](/components/index) for more details.

docs/zh/guide/getting-started.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,18 @@ pnpm install starter-lib-vue3
2323
<script src="https://unpkg.com/starter-lib-vue3"></script>
2424
```
2525

26-
它将作为 `window.StarterLibTs` 暴露在全局对象中
26+
它将作为 `window.StarterLibVue3` 暴露在全局对象中
2727

2828
## 使用示例
2929

30-
```js
31-
import { sayHello } from 'starter-lib-vue3'
30+
```vue
31+
<script setup>
32+
import { SayHello } from 'starter-lib-vue3'
33+
</script>
3234
33-
sayHello('Kieran')
35+
<template>
36+
<SayHello name="Kieran" />
37+
</template>
3438
```
3539

36-
更多详情请参考[函数列表](/functions/index)
40+
更多详情请参考[组件列表](/components/index)

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
},
3636
"main": "dist/lib/index.js",
3737
"module": "dist/es/index.js",
38-
"unpkg": "dist/index.global.js",
39-
"jsdelivr": "dist/index.global.js",
38+
"unpkg": "dist/iife/index.global.js",
39+
"jsdelivr": "dist/iife/index.js",
4040
"types": "dist/types/index.d.ts",
4141
"files": [
4242
"dist"

0 commit comments

Comments
 (0)