Skip to content

Commit 962f11f

Browse files
committed
docs: add readme
1 parent e77e78a commit 962f11f

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

packages/vue-final-modal/README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Vue Final Modal 4
2+
3+
The most powerful yet most light-weight modal library for Vue 3.
4+
5+
<p align="center"><a href="https://vue-final-modal.org" target="_blank" rel="noopener noreferrer"><img src="https://vue-final-modal.org/preview.png" alt="Vue Final Modal Logo"></a></p>
6+
7+
<p align="center">
8+
<a href="https://npmcharts.com/compare/vue-final-modal?minimal=true"><img src="https://badgen.net/npm/dm/vue-final-modal" alt="Downloads"></a>
9+
<a href="https://www.npmjs.com/package/vue-final-modal"><img src="https://img.shields.io/npm/l/vue-final-modal.svg?sanitize=true" alt="License"></a>
10+
<a href="https://app.netlify.com/sites/vue-final-modal/deploys"><img src="https://api.netlify.com/api/v1/badges/444b13a8-540f-4438-94da-80c865c8f103/deploy-status" alt="Netlify Status"></a>
11+
</p>
12+
<p align="center">
13+
<a href="https://www.npmjs.com/package/vue-final-modal"><img src="https://badgen.net/npm/v/vue-final-modal/beta" alt="Version"></a>
14+
</p>
15+
16+
<p align="right">
17+
<a href="https://www.buymeacoffee.com/PL2qJIx" target="_blank" rel="noopener noreferrer">
18+
<img width="200" src="https://cdn.buymeacoffee.com/buttons/v2/default-green.png" alt="Buy Me A Coffee" />
19+
</a>
20+
</p>
21+
22+
## [Documentation](https://v4.vue-final-modal.org/)
23+
24+
Checkout [Migration guide from v3](https://v4.vue-final-modal.org/get-started/migration/from-v3).
25+
26+
Looking for old version?
27+
28+
- [vue-final-modal@3.x for Vue 3](https://v3.vue-final-modal.org/)
29+
- [vue-final-modal@2.x for Vue 2](https://v2.vue-final-modal.org/)
30+
31+
## Contribution Guide
32+
33+
```bash [pnpm]
34+
# Install packages
35+
pnpm install --shamefully-hoist
36+
37+
# Build vue-final-modal library first
38+
pnpm build:vfm
39+
40+
# Run both docs and viteplay
41+
pnpm dev
42+
43+
# Run docs: http://localhost:3000/
44+
pnpm dev:docs
45+
46+
# Run viteplay: http://localhost:5173/
47+
pnpm dev:viteplay
48+
```
49+
50+
## Contributors
51+
52+
Thank you to all the people who already contributed to `vue-final-modal`!
53+
54+
<a href="https://github.com/vue-final/vue-final-modal/graphs/contributors" aria-label="contributors">
55+
<img src="https://contrib.rocks/image?repo=vue-final/vue-final-modal" alt="contributors" />
56+
</a>
57+
58+
Made with [contributors-img](https://contrib.rocks).
59+
60+
🚀 If you have any ideas for optimization of `vue-final-modal`, feel free to open [issues](https://github.com/hunterliu1003/vue-final-modal/issues) or [pull requests](https://github.com/hunterliu1003/vue-final-modal/pulls).

0 commit comments

Comments
 (0)