import { Meta } from '@storybook/addon-docs';

<Meta
    title="Introduction"
    parameters={{
        viewMode: 'docs',
        previewTabs: {
            'canvas': {
                hidden: true,
            },
        },
    }}
/>

# Welcome to Polaris Vue

Polaris Vue by HulkApps is a component library for [Vue.js](https://vuejs.org/) based on
[Shopify Polaris style guide](https://polaris.shopify.com/).

## Quick start

You need [Vue.js](https://vuejs.org/) **version 2+**.

### 1. Install via npm

<br/>

#### Using NPM
```bash
npm i @hulkapps/polaris-vue
```

#### Using Yarn
```bash
yarn add @hulkapps/polaris-vue
```

### 2. Import and use Polaris Vue

```javascript
import Vue from 'vue';
import PolarisVue from '@hulkapps/polaris-vue';
import '@hulkapps/polaris-vue/dist/polaris-vue.min.css';
Vue.use(PolarisVue);
```

#### Other available builds
```javascript
'/dist/polaris-vue.min.js';
'/dist/polaris-vue.ssr.js';
'/dist/polaris-vue.esm.js';
```

## Contributing

If you stumble upon a bug, create issue ticket under [polaris-vue](https://github.com/hulkapps/polaris-vue). Also, pull requests are welcome.

## License

Code released under [MIT](https://github.com/HulkApps/polaris-vue/blob/master/LICENSE) license.