Skip to content

Commit 1d0e0da

Browse files
committed
docs: update readme
1 parent bf11bf5 commit 1d0e0da

File tree

1 file changed

+13
-36
lines changed

1 file changed

+13
-36
lines changed

README.md

Lines changed: 13 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,10 @@
1-
# vue-select ![Current Release](https://img.shields.io/github/release/sagalbot/vue-select.svg?style=flat-square) ![Release Date](https://img.shields.io/github/release-date/sagalbot/vue-select?style=flat-square) ![Bundle Size](https://flat.badgen.net/bundlephobia/min/vue-select) ![Monthly Downloads](https://img.shields.io/npm/dm/vue-select.svg?style=flat-square) [![Coverage Status](https://coveralls.io/repos/github/sagalbot/vue-select/badge.svg?branch=master)](https://coveralls.io/github/sagalbot/vue-select?branch=master) ![MIT License](https://img.shields.io/github/license/sagalbot/vue-select.svg?style=flat-square)
2-
3-
> **Everything you wish the HTML `<select>` element could do, wrapped up into a lightweight, zero
4-
> dependency, extensible Vue component.**
5-
6-
Vue Select is a feature rich select/dropdown/typeahead component. It provides a default
7-
template that fits most use cases for a filterable select dropdown. The component is designed to be as
8-
lightweight as possible, while maintaining high standards for accessibility,
9-
developer experience, and customization.
10-
11-
- Tagging
12-
- Filtering / Searching
13-
- Vuex Support
14-
- AJAX Support
15-
- SSR Support
16-
- Accessible
17-
- ~20kb Total / ~5kb CSS / ~15kb JS
18-
- Select Single/Multiple Options
19-
- Customizable with slots and SCSS variables
20-
- Zero dependencies
1+
# vue3-select
2+
3+
This is a forked and maintained version of sagalbot/vue-select, which is no longer maintained. As the name suggests, this project is specifically designed to work with the Vue 3.
4+
5+
Note: At the moment, most of the features of vue3-select are the same as the original vue-select project. As such, users can refer to the original documentation for usage instructions.
6+
7+
New documentation specific to vue3-select will be available soon as the project introduces new features and enhancements that differentiate it from the original project.
218

229
## Documentation
2310

@@ -26,47 +13,37 @@ Complete documentation and examples available at https://vue-select.org.
2613
- **[API Documentation](https://vue-select.org)**
2714
- **[CodePen Template](http://codepen.io/sagalbot/pen/NpwrQO)**
2815

29-
## Sponsors :tada:
30-
31-
It takes a lot of effort to maintain this project. If it has saved you development time, please consider [sponsoring the project](https://github.com/sponsors/sagalbot)
32-
with GitHub sponsors!
33-
34-
Huge thanks to the [sponsors](https://github.com/sponsors/sagalbot) and [contributors](https://github.com/sagalbot/vue-select/graphs/contributors) that make Vue Select possible!
35-
3616
## Install
3717

3818
```bash
39-
yarn add vue-select
19+
yarn add vue3-select
4020

4121
# or use npm
4222

43-
npm install vue-select
23+
npm install vue3-select
4424
```
4525

4626
Then, import and register the component:
4727

4828
```js
4929
import Vue from "vue";
50-
import vSelect from "vue-select";
30+
import VueSelect from "vue3-select";
5131

52-
Vue.component("v-select", vSelect);
32+
Vue.component("v-select", VueSelect);
5333
```
5434

5535
The component itself does not include any CSS. You'll need to include it separately:
5636

5737
```js
58-
import "vue-select/dist/vue-select.css";
38+
import "vue3-select/dist/vue-select.css";
5939
```
6040

6141
Alternatively, you can import the scss for complete control of the component styles:
6242

6343
```scss
64-
@import "vue-select/src/scss/vue-select.scss";
44+
@import "vue3-select/src/scss/vue-select.scss";
6545
```
6646

67-
You can also include vue-select directly in the browser. Check out the
68-
[documentation for loading from CDN.](https://vue-select.org/guide/install.html#in-the-browser).
69-
7047
## License
7148

7249
[MIT](https://github.com/sagalbot/vue-select/blob/master/LICENSE.md)

0 commit comments

Comments
 (0)