Skip to content

Commit c8e9127

Browse files
DIYgodDIYgod
committed
update README and LICENSE
1 parent dedcfbf commit c8e9127

3 files changed

Lines changed: 79 additions & 59 deletions

File tree

‎LICENSE‎

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
The Star And Thank Author License (SATA)
1+
The MIT License (MIT)
22

3-
Copyright (c) 2016-2017 DIYgod([email protected])
4-
5-
Project Url: https://github.com/DIYgod/APlayer
3+
Copyright (c) DIYgod <[email protected]> (https://www.anotherhome.net/)
64

75
Permission is hereby granted, free of charge, to any person obtaining a copy
86
of this software and associated documentation files (the "Software"), to deal
@@ -14,20 +12,6 @@ furnished to do so, subject to the following conditions:
1412
The above copyright notice and this permission notice shall be included in
1513
all copies or substantial portions of the Software.
1614

17-
And wait, the most important, you shall star/+1/like the project(s) in project url
18-
section above first, and then thank the author(s) in Copyright section.
19-
20-
Here are some suggested ways:
21-
22-
- Email the authors a thank-you letter, and make friends with him/her/them.
23-
- Report bugs or issues.
24-
- Tell friends what a wonderful project this is.
25-
- And, sure, you can just express thanks in your mind without telling the world.
26-
27-
Contributors of this project by forking have the option to add his/her name and
28-
forked project url at copyright and project url sections, but shall not delete
29-
or modify anything else in these two sections.
30-
3115
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
3216
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
3317
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

‎README.md‎

Lines changed: 76 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,115 @@
1-
# APlayer
1+
<p align="center">
2+
<img src="https://ws4.sinaimg.cn/large/006tKfTcgy1fhu01y9uy7j305k04s3yc.jpg" alt="ADPlayer" width="100">
3+
</p>
4+
<h1 align="center">APlayer</h1>
5+
6+
> Wow, such a lovely HTML5 music player
27
38
[![npm](https://img.shields.io/npm/v/aplayer.svg?style=flat-square)](https://www.npmjs.com/package/aplayer)
49
[![npm](https://img.shields.io/npm/l/aplayer.svg?style=flat-square)](https://github.com/DIYgod/APlayer/blob/master/LICENSE)
510
[![devDependency Status](https://img.shields.io/david/dev/DIYgod/aplayer.svg?style=flat-square)](https://david-dm.org/DIYgod/APlayer#info=devDependencies)
611
[![npm](https://img.shields.io/npm/dt/aplayer.svg?style=flat-square)](https://www.npmjs.com/package/aplayer)
712
[![Travis](https://img.shields.io/travis/DIYgod/APlayer.svg?style=flat-square)](https://travis-ci.org/DIYgod/APlayer)
8-
[![%e2%9d%a4](https://img.shields.io/badge/made%20with-%e2%9d%a4-ff69b4.svg?style=flat-square)](https://www.anotherhome.net/)
9-
10-
> Wow, such a beautiful html5 music player
13+
[![donate](https://img.shields.io/badge/$-donate-ff69b4.svg?style=flat-square)](https://github.com/DIYgod/APlayer#donate)
1114

1215
## Introduction
1316

14-
[Demo](http://aplayer.js.org)
15-
16-
[Docs](http://aplayer.js.org/docs)
17-
18-
Using APlayer on your project? [Let me know!](https://github.com/DIYgod/APlayer/issues/79)
19-
20-
Screenshot
2117
![image](https://i.imgur.com/JDrJXCr.png)
2218

23-
## Install
24-
25-
```
26-
$ npm install aplayer --save
27-
```
28-
29-
## CDN
19+
APlayer is a lovely HTML5 music player to help people build audio easily.
3020

31-
[unpkg](https://unpkg.com/aplayer)
21+
**APlayer supports:**
3222

33-
[cdnjs](https://cdnjs.com/libraries/aplayer)
23+
- Media formats
24+
- MP3
25+
- WAVE PCM
26+
- Ogg Theora Vorbis
27+
- Features
28+
- Playlist
29+
- Lyrics
3430

35-
[BootCDN](http://www.bootcdn.cn/aplayer)
31+
Using APlayer on your project? [Let me know!](https://github.com/DIYgod/APlayer/issues/79)
3632

37-
## Usage
33+
**[Demo](http://aplayer.js.org)**
3834

39-
See [docs](http://aplayer.js.org/docs)
35+
**[Docs](http://aplayer.js.org/docs)**
4036

41-
## Run in development
37+
## Install
4238

4339
```
44-
$ npm install
45-
$ npm run dev
40+
$ npm install aplayer --save
4641
```
4742

48-
## Make a release
43+
## Quick Start
4944

45+
```html
46+
<div id="alayer1"></div>
47+
<script src="dist/APlayer.min.js"></script>
5048
```
51-
$ npm install
52-
$ npm run build
49+
50+
```js
51+
var ap = new APlayer({
52+
element: document.getElementById('player1'),
53+
music: {
54+
title: 'Preparation',
55+
author: 'Hans Zimmer/Richard Harvey',
56+
url: 'Preparation.mp3',
57+
}
58+
});
5359
```
5460

55-
## Communication Groups
61+
## Usage
62+
63+
[Read the Docs](http://aplayer.js.org/docs)
5664

57-
[Telegram Group](https://t.me/adplayer)
65+
## Join the Discussion
5866

59-
[QQ Group: 415835947](https://shang.qq.com/wpa/qunwpa?idkey=bf22213ae0028a82e5adf3f286dfd4f01e0997dc9f1dcd8e831a0a85e799be17)
67+
- [Telegram Group](https://t.me/adplayer)
68+
- [QQ Group](https://shang.qq.com/wpa/qunwpa?idkey=bf22213ae0028a82e5adf3f286dfd4f01e0997dc9f1dcd8e831a0a85e799be17): 415835947
6069

6170
## Related Projects
6271

6372
- [APlayer-Typecho-Plugin](https://github.com/zgq354/APlayer-Typecho-Plugin)
64-
6573
- [hexo-tag-aplayer](https://github.com/grzhan/hexo-tag-aplayer)
66-
6774
- [163music-APlayer-you-get-docker](https://github.com/YUX-IO/163music-APlayer-you-get-docker)
68-
6975
- [Hermit-X(APlayer for WordPress)](https://github.com/liwanglin12/Hermit-X)
70-
7176
- [vue-aplayer](https://github.com/SevenOutman/vue-aplayer)
72-
7377
- [APlayer_for_Z-BlogPHP](https://github.com/fghrsh/APlayer_for_Z-BlogPHP)
74-
7578
- [php-aplayer](https://github.com/Daryl-L/php-aplayer)
79+
- [react-aplayer](https://github.com/sabrinaluo/react-aplayer)
80+
- Feel free to submit yours in [`Let me know!`](https://github.com/DIYgod/APlayer/issues/79)
81+
82+
## Who use APlayer?
83+
84+
- [Anotherhome](https://www.anotherhome.net/2717)
85+
- [站长之家](http://www.chinaz.com/15year/index.html)
86+
- [TheFatRat](http://thefatrat.cn/)
87+
- [Jelly Rue](http://jellyrue.com/)
88+
- [LWL的自由天空](https://blog.lwl12.com/read/hermit-x.html)
89+
- [萨摩公园](https://i-meto.com/meting-typecho/)
90+
- [ZGQ's Blog](https://blog.izgq.net/archives/456/)
91+
- [FGHRSH 的博客](https://www.fghrsh.net/post/77.html)
92+
- [Blessing Studio](https://blessing.studio/generate-aplayer-config-from-netease-automatically/)
93+
- [暮光博客](https://muguang.me/guff/2645.html)
94+
- Feel free to submit yours in [`Let me know!`](https://github.com/DIYgod/APlayer/issues/79)
95+
96+
## CDN
97+
98+
- [unpkg](https://unpkg.com/aplayer)
99+
- [cdnjs](https://cdnjs.com/libraries/aplayer)
100+
- [BootCDN](http://www.bootcdn.cn/aplayer/)
101+
- [RawGit](https://rawgit.com/DIYgod/APlayer/master/dist/APlayer.min.js)
102+
103+
## Donate
104+
105+
- [Donate via Paypal](https://www.paypal.me/DIYgod)
106+
- [Donate via WeChat Pay](https://ws4.sinaimg.cn/large/006tKfTcgy1fhu1uowywej307s07st8h.jpg)
107+
- [Donate via Alipay](https://ws4.sinaimg.cn/large/006tKfTcgy1fhu1vf4ih7j307s07sdfm.jpg)
108+
- Donate via Bitcoin: 13CwQLHzPYm2tewNMSJBeArbbRM5NSmCD1
109+
110+
## Author
76111

77-
## LICENSE
112+
**APlayer** © [DIYgod](https://github.com/DIYgod), Released under the [MIT](./LICENSE) License.<br>
113+
Authored and maintained by DIYgod with help from contributors ([list](https://github.com/DIYgod/APlayer/contributors)).
78114

79-
[The Star And Thank Author License (SATA)](https://github.com/DIYgod/APlayer/blob/master/LICENSE)
115+
> Blog [@Anotherhome](https://www.anotherhome.net) · GitHub [@DIYgod](https://github.com/DIYgod) · Twitter [@DIYgod](https://twitter.com/DIYgod) · Weibo [@DIYgod酱](http://weibo.com/anotherhome) · Telegram Channel [@awesomeDIYgod](https://t.me/awesomeDIYgod)

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"html5"
1919
],
2020
"author": "DIYgod",
21-
"license": "SATA",
21+
"license": "MIT",
2222
"bugs": {
2323
"url": "https://github.com/DIYgod/APlayer/issues"
2424
},

0 commit comments

Comments
 (0)