translucent-vue/README.md

A Vue binding for translucent

# translucent-vue
>  A Vue binding for [byeolbit/translucent](https://www.npmjs.com/package/translucent)

For help you can have a look at [the guide](https://voltra.github.io/translucent-vue/) or [join my discord server](https://discordapp.com/invite/JtWAjbw). If there is any issue with this library, please feel free to [open an issue on github](https://github.com/Voltra/translucent-vue/issues).

## Install

### Package manager

```bash
npm i -S translucent-vue

yarn add translucent-vue
```

```javascript
// import
import { Plugin, Translucent } from "translucent-vue"
import "translucent-vue/src/styles.scss" // or dist/index.css

// require
const { Plugin, Translucent } = require("translucent-vue");
require("translucent-vue/src/styles.scss"); // or dist/index.css
```

### Script tag

```html
<script defer src="path/to/translucent-vue/dist/index.bundle.js"></script>
<link rel="stylesheet" href="path/to/translucent-vue/dist/index.css"/>
```



## Basic demo

You can have a look at the very basic demo in the `demo` directory on github, or refer to [the guide](https://voltra.github.io/translucent-vue/) .