Skip to content

Commit fe18c2c

Browse files
authored
chore: update README
1 parent 493a330 commit fe18c2c

File tree

1 file changed

+32
-16
lines changed

1 file changed

+32
-16
lines changed

README.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,46 @@
1-
# Vue3-Select-Component
1+
<br />
22

33
<p align="center">
4-
<img src="https://vue3-select-component.vercel.app/logo.png" alt="Vue3 Select Component" height="256" width="256" />
4+
<a href="https://vue3-select-component.vercel.app/">
5+
<img src="https://vue3-select-component.vercel.app/logo.png" alt="Vue3 Select Component" height="256" width="256" />
6+
</a>
7+
</p>
8+
9+
<h1 align="center">
10+
Vue3-Select-Component
11+
</h1>
12+
13+
<p align="center">
14+
Best-in-class select component for Vue 3, with a focus on DX, accessibility and ease-of-use.
515
</p>
616

717
<p align="center">
8-
<a href="https://www.npmjs.com/package/vue3-select-component">
9-
<img src="https://img.shields.io/npm/v/vue3-select-component.svg" alt="npm package" />
18+
<a href="https://www.npmjs.com/package/vue3-select-component" target="__blank">
19+
<img src="https://img.shields.io/npm/v/vue3-select-component.svg?style=flat" alt="npm package" />
1020
</a>
1121

12-
<a href="https://www.npmjs.com/package/vue3-select-component">
13-
<img src="https://img.shields.io/npm/dm/vue3-select-component" alt="npm package" />
22+
<a href="https://www.npmjs.com/package/vue3-select-component" target="__blank">
23+
<img src="https://img.shields.io/npm/dm/vue3-select-component?style=flat" alt="npm package" />
1424
</a>
1525

16-
<a href="https://github.com/TotomInc/vue3-select-component/actions/workflows/build.yml">
17-
<img src="https://github.com/TotomInc/vue3-select-component/actions/workflows/build.yml/badge.svg?branch=master" alt="CI status" />
26+
<a href="https://github.com/TotomInc/vue3-select-component" target="__blank">
27+
<img alt="GitHub stars" src="https://img.shields.io/github/stars/TotomInc/vue3-select-component?flat">
1828
</a>
1929
</p>
2030

2131
<p align="center">
22-
<b>Docs & demos</b>: <a href="https://vue3-select-component.vercel.app">vue3-select-component.vercel.app</a>
32+
<a href="https://vue3-select-component.vercel.app/" target="__blank">Documentation</a> | <a href="https://vue3-select-component.vercel.app/getting-started.html" target="__blank">Getting Started</a> | <a href="https://vue3-select-component.vercel.app/demo/single-select.html" target="__blank">Examples / Demos</a>
2333
</p>
2434

25-
> Best-in-class select component for Vue 3, with a focus on DX, accessibility and ease-of-use.
35+
**Core features:**
2636

2737
- ⚙️ Data manipulation with `v-model`
28-
- 🔑 Type-safe
38+
- 🔑 [Typesafe relationship](https://vue3-select-component.vercel.app/typescript.html) between `options` and `v-model`
2939
- 🎨 Great styling out-of-the-box, customization with CSS variables & Vue `:deep`
30-
- ✅ Single & multi-select
31-
- 🖌️ Customization with `<slot>`s
32-
- 🪄 Teleport/portal menu
33-
- 📦 Extremely light (3.1kb gzip)
40+
- ✅ Single & multi-select support
41+
- 🖌️ Infinite customization with `<slot>`s
42+
- 🪄 `<Teleport />` menu where you want
43+
- 📦 Extremely light, **0 dependencies** (4.4kb gzip)
3444

3545
## Installation
3646

@@ -56,7 +66,7 @@ const option = ref("");
5666
v-model="option"
5767
:options="[
5868
{ label: 'A Wizard of Earthsea', value: 'wizard_earthsea' },
59-
{ label: 'Harry Potter and the Philosopher\'s Stone', value: 'harry_potter' },
69+
{ label: 'Harry Potter and the Philosopher\'s Stone', value: 'harry_potter', disabled: true },
6070
{ label: 'The Lord of the Rings', value: 'the_lord_of_the_rings' },
6171
]"
6272
/>
@@ -96,6 +106,12 @@ const userOptions: UserOption[] = [
96106
</template>
97107
```
98108

109+
[There's an entire documentation page](https://vue3-select-component.vercel.app/typescript.html) dedicated to usage with TypeScript.
110+
111+
## Releases
112+
113+
For changelog, visit [releases](https://github.com/TotomInc/vue3-select-component/releases).
114+
99115
## License
100116

101117
MIT Licensed. Copyright (c) Thomas Cazade 2024 - present.

0 commit comments

Comments
 (0)