vue-audio/README.md

vue.js audio files player

## Vue.js sound player

Vue.js sound audio player UI. Covers audio-tag API and adds more.

![dependencies status](https://david-dm.org/shershen08/vuejs-sound-player/status.svg)

### Demo

See [DEMO](https://shershen08.github.io/vue-plugins-demo-static/index.html#/sound) here

### Installation

Use npm: ```npm install vue-audio --save```

Or bower: ```bower install vue-audio```

### Usage

Add in the component ```import VueAudio from 'vue-audio';```

Use in the template ```<vue-audio file="myLocalFile"></vue-audio>```

The component has following attributes:

 - **file** (String), required;
 - **autoPlay** (Boolean), optional, false by default;
 - **loop**  (Boolean), optional, false by default;

 For styling the Bootstrap classes v 3.7 are used, so you may want to add [bootstrap css](https://www.npmjs.com/package/bootstrap-css) package or add via stylesheet link ```<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css">```

### Questions, bugs

Create [an issue](https://github.com/shershen08/vuejs-sound-player/issues) or try to ping me on twitter [@legkoletat](https://twitter.com/legkoletat)

### Contribute

### 1. install dependencies

```
yarn install
```

### 2. run the dev server

```
yarn dev
```

and then access the url which the project is running at(example: http://localhost:8081/) . Otherwise, you can simplify run this command.

```
yarn open
```

It will open the website after building.

### License

MIT