> For the complete documentation index, see [llms.txt](https://alexskubala.gitbook.io/vui/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://alexskubala.gitbook.io/vui/master.md).

# Welcome

## Getting started

To add Vui to your project you have to get through two steps: adding the package, adding this library to your Vue instance.

```bash
npm i vui3
# OR
yarn vui3
```

{% hint style="warning" %}
 Remember that this library works on Vue 3
{% endhint %}

{% code title="main.js" %}

```javascript
import { createApp } from 'vue';
import Vui from 'vui3';
import App from './App.vue';

const app = createApp(App);
app.use(Vui);

app.mount('#app');
```

{% endcode %}