Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
wshunli committed Jan 4, 2019
1 parent 2bf03ff commit 5ca9936
Showing 1 changed file with 35 additions and 4 deletions.
39 changes: 35 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,50 @@ Insert [cPlayer](https://github.com/MoePlayer/cPlayer) in Hexo by using tags.
$ npm install hexo-tag-mplayer --save
```

## Usage
## Quick Start

``` JavaScript
{% mplayer %}
{
// TODO mplayer options goes here
}
playlist: [
{
name: 'Song name...',
artist: 'Singer name...',
src: 'Song resource link...',
poster: 'Song Cover link...',
lyric: 'Lyrics...',
Sublyric: 'Deputy lyrics, generally for translation...'
},
{
...
},
...
],
autoplay: true,
volume: 0.75,
playmode: "listloop",
big: true,
dark: false
{% endmplayer %}
```

For more details, visit [hexo-tag-mplayer Demo](http://www.wshunli.com/hexo-tag-mplayer.html) here.

# Option

|OPTION|default content|description|
|:-----|:-------------:|:----------|
|playlist|`[]`|Playlist.|
|autoplay|`false`|Autoplay (mobile is not available).|
|volume|`1`|Default volume.|
|playmode|`listloop`|Default play mode. |
|big|`false`|Default player size. |
|dark|`false`|Default player theme. |

For more details, visit [CPlayer Demo](https://cplayer.js.org/) here.

# Thanks

Thanks for [cPlayer](https://github.com/MoePlayer/cPlayer) & Inspired by [hexo-tag-cplayer](https://github.com/EYHN/hexo-tag-cplayer) .

## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fwshunli%2Fhexo-tag-mplayer.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fwshunli%2Fhexo-tag-mplayer?ref=badge_large)

0 comments on commit 5ca9936

Please sign in to comment.