# Installation

## Direct Download / CDN

<https://unpkg.com/vrkflow>

[Unpkg.com](http://unpkg.com) provides NPM-based CDN links. The above link will always point to the latest release on NPM. You can also use a specific version/tag via URLs like `https://unpkg.com/vrkflow@0.2.0`.

To use ``vrkflow`` without install the module, copy the code below into your index.html. 
This will pull the latest version of vrkflow, allowing you to start using the mixin and the store module generator.

```html
<script src="https://unpkg.com/vrkflow/index.js"></script>
```

## yarn / npm

To include ``vrkflow`` into an existing project, you must install its npm package. You can use either npm or yarn to accomplish this task.
For a detailed explanation of how to get ``npm`` running in your environment, check out the [official documentation](https://docs.npmjs.com/about-npm/index.html). 

## Create the store / module
In your store's entry point, import the object VrkflowStore and wrap your store/store's module:

```javascript
import { VrkflowStore } from 'vrkflow';
Vue.use(Vuex);
const store = new Vuex.Store(VrkflowStore({
  // getters (optional)
  // actions (optional)
  // mutations (optional)
  // state (optional)
}));
```

## Use the mixin
In your component, import the object VrkflowMixin and use it

```javascript
import { VrkflowMixin } from 'vrkflow';

export default {
  mixins: [VrkflowMixin],
};

```