Skip to content

Commit 29245dc

Browse files
committed
docs: revise installation & usage
1 parent 51ba096 commit 29245dc

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,28 +19,32 @@ You can install `@watermarkify/vue-watermark` via npm or yarn:
1919

2020
```bash
2121
npm install @watermarkify/vue-watermark
22-
2322
# or
24-
2523
yarn add @watermarkify/vue-watermark
24+
# or
25+
pnpm install @watermarkify/vue-watermark
2626
```
2727

2828
## Usage
2929

30+
Retrieved from [playground](./playground/)
31+
3032
```vue
31-
<script setup>
33+
<script setup lang="ts">
3234
import { ref } from 'vue'
35+
// step 1: import Watermark from @watermarkify/vue-watermark
3336
import { Watermark } from '@watermarkify/vue-watermark'
3437
38+
// step 2: define watermark options
3539
const watermarkOptions = ref({
36-
content: 'watermark',
37-
},
38-
)
40+
content: 'watermark'
41+
})
3942
</script>
4043
4144
<template>
4245
<div>
4346
<h1>Watermark Example</h1>
47+
<!-- step 3: apply watermark on the target slot -->
4448
<Watermark :options="watermarkOptions">
4549
<div class="content">This is the content of the slot.</div>
4650
</Watermark>

0 commit comments

Comments
 (0)