Browse Source

update README and LICENSE

DIYgod 7 years ago
parent
commit
86ad08cd1a
2 changed files with 74 additions and 61 deletions
  1. 2 18
      LICENSE
  2. 72 43
      README.md

+ 2 - 18
LICENSE

@@ -1,8 +1,6 @@
-The Star And Thank Author License (SATA)
+The MIT License (MIT)
 
 
-Copyright (c) 2016-2017 DIYgod(i@html.love)
-
-Project Url: https://github.com/DIYgod/DPlayer
+Copyright (c) DIYgod <diy.d.god@gmail.com> (https://www.anotherhome.net/)
 
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 of this software and associated documentation files (the "Software"), to deal
@@ -14,20 +12,6 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in
 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.
 all copies or substantial portions of the Software.
 
 
-And wait, the most important, you shall star/+1/like the project(s) in project url
-section above first, and then thank the author(s) in Copyright section.
-
-Here are some suggested ways:
-
- - Email the authors a thank-you letter, and make friends with him/her/them.
- - Report bugs or issues.
- - Tell friends what a wonderful project this is.
- - And, sure, you can just express thanks in your mind without telling the world.
-
-Contributors of this project by forking have the option to add his/her name and
-forked project url at copyright and project url sections, but shall not delete
-or modify anything else in these two sections.
-
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

+ 72 - 43
README.md

@@ -1,4 +1,7 @@
-# ![logo](https://ws3.sinaimg.cn/large/006tKfTcgy1fhgixc80whj300y00pgld.jpg)DPlayer
+<p align="center">
+<img src="https://ws4.sinaimg.cn/large/006tKfTcgy1fhu01y9uy7j305k04s3yc.jpg" alt="ADPlayer" width="100">
+</p>
+<h1 align="center">DPlayer</h1>
 
 
 [![npm](https://img.shields.io/npm/v/dplayer.svg?style=flat-square)](https://www.npmjs.com/package/dplayer)
 [![npm](https://img.shields.io/npm/v/dplayer.svg?style=flat-square)](https://www.npmjs.com/package/dplayer)
 [![npm](https://img.shields.io/npm/l/dplayer.svg?style=flat-square)](https://github.com/DIYgod/DPlayer/blob/master/LICENSE)
 [![npm](https://img.shields.io/npm/l/dplayer.svg?style=flat-square)](https://github.com/DIYgod/DPlayer/blob/master/LICENSE)
@@ -11,13 +14,29 @@
 
 
 ## Introduction
 ## Introduction
 
 
-[Demo](http://dplayer.js.org/)
+DPlayer is a lovely HTML5 danmaku video player to help people play video and danmaku easily.
 
 
-[Docs](http://dplayer.js.org/docs)
+**DPlayer supports:**
+
+- Streaming formats:
+	- [HLS](https://github.com/video-dev/hls.js)
+	- [FLV](https://github.com/Bilibili/flv.js)
+- Media formats:
+	- MP4 H.264
+	- WebM
+	- Ogg
+- Features:
+	- Danamku
+	- Screenshot
+	- Hotkeys
+	- Quality switching
 
 
 Using DPlayer on your project? [Let me know!](https://github.com/DIYgod/DPlayer/issues/31)
 Using DPlayer on your project? [Let me know!](https://github.com/DIYgod/DPlayer/issues/31)
 
 
-Screenshot
+**[Demo](http://dplayer.js.org/)**
+
+**[Docs](http://dplayer.js.org/docs)**
+
 ![image](http://i.imgur.com/207ch36.jpg)
 ![image](http://i.imgur.com/207ch36.jpg)
 
 
 ## Install
 ## Install
@@ -26,18 +45,14 @@ Screenshot
 $ npm install dplayer --save
 $ npm install dplayer --save
 ```
 ```
 
 
-## CDN
-
-[unpkg](https://unpkg.com/dplayer)
-
-[cdnjs](https://cdnjs.com/libraries/dplayer)
-
-[BootCDN](http://www.bootcdn.cn/dplayer/)
-
-[RawGit](https://rawgit.com/DIYgod/DPlayer/master/dist/DPlayer.min.js)
-
 ## Quick Start
 ## Quick Start
 
 
+```html
+<link rel="stylesheet" href="https://rawgit.com/DIYgod/DPlayer/master/dist/DPlayer.min.css">
+<div id="player1"></div>
+<script src="https://rawgit.com/DIYgod/DPlayer/master/dist/DPlayer.min.js"></script>
+```
+
 ```js
 ```js
 var dp = new DPlayer({
 var dp = new DPlayer({
     element: document.getElementById('player1'),
     element: document.getElementById('player1'),
@@ -56,48 +71,62 @@ var dp = new DPlayer({
 
 
 See [docs](http://dplayer.js.org/docs)
 See [docs](http://dplayer.js.org/docs)
 
 
-## Run in development
-
-```
-$ npm install
-$ npm run dev
-```
-
-## Make a release
-
-```
-$ npm install
-$ npm run build
-```
-
-## Communication Groups
-
-[Telegram Group](https://t.me/adplayer)
+## Join the Discussion
 
 
-[QQ Group: 415835947](https://shang.qq.com/wpa/qunwpa?idkey=bf22213ae0028a82e5adf3f286dfd4f01e0997dc9f1dcd8e831a0a85e799be17)
+- [Telegram Group](https://t.me/adplayer)
+- [QQ Group](https://shang.qq.com/wpa/qunwpa?idkey=bf22213ae0028a82e5adf3f286dfd4f01e0997dc9f1dcd8e831a0a85e799be17): 415835947
 
 
 ## Related Projects
 ## Related Projects
 
 
 - [DPlayer-backend](https://github.com/DIYgod/DPlayer-backend)
 - [DPlayer-backend](https://github.com/DIYgod/DPlayer-backend)
-
 - [DPlayer-data(weekly backup for api.prprpr.me/dplayer)](https://github.com/DIYgod/DPlayer-data)
 - [DPlayer-data(weekly backup for api.prprpr.me/dplayer)](https://github.com/DIYgod/DPlayer-data)
-
 - [DPlayer-for-typecho](https://github.com/volio/DPlayer-for-typecho)
 - [DPlayer-for-typecho](https://github.com/volio/DPlayer-for-typecho)
-
 - [Hexo-tag-dplayer](https://github.com/NextMoe/hexo-tag-dplayer)
 - [Hexo-tag-dplayer](https://github.com/NextMoe/hexo-tag-dplayer)
-
 - [DPlayer_for_Z-BlogPHP](https://github.com/fghrsh/DPlayer_for_Z-BlogPHP)
 - [DPlayer_for_Z-BlogPHP](https://github.com/fghrsh/DPlayer_for_Z-BlogPHP)
-
 - [纸飞机视频区插件(DPlayer for Discuz!)](https://coding.net/u/Click_04/p/video/git)
 - [纸飞机视频区插件(DPlayer for Discuz!)](https://coding.net/u/Click_04/p/video/git)
-
 - [dplayer_py_backend](https://github.com/dixyes/dplayer_py_backend)
 - [dplayer_py_backend](https://github.com/dixyes/dplayer_py_backend)
-
 - [dplayer_lua_backend](https://github.com/dixyes/dplayer_lua_backend)
 - [dplayer_lua_backend](https://github.com/dixyes/dplayer_lua_backend)
-
 - [DPlayer for WordPress](https://github.com/BlueCocoa/DPlayer-WordPress)
 - [DPlayer for WordPress](https://github.com/BlueCocoa/DPlayer-WordPress)
-
 - [Vue-DPlayer](https://github.com/sinchang/vue-dplayer)
 - [Vue-DPlayer](https://github.com/sinchang/vue-dplayer)
+- Feel free to submit yours in [`Let me know`](https://github.com/DIYgod/DPlayer/issues/31)
+
+## Who use DPlayer?
+
+- [Anotherhome](https://www.anotherhome.net/2648)
+- [嘀哩嘀哩](http://www.dilidili.wang/)
+- [息萌](http://ximeng.co/)
+- [TALD](https://github.com/maysrp/TALD)
+- [webdir](https://github.com/maysrp/webdir)
+- [0xBBC](https://blog.0xbbc.com/2016/09/dplayer-for-wordpress/)
+- [树洞](https://aoaoao.me/1031.html)
+- [FGHRSH的博客](https://www.fghrsh.net/post/57.html)
+- [银色子弹](https://www.sbsub.com/)
+- [妖气山弹幕网](http://www.m173.tv/)
+- [御宅同萌 – 聖域](https://wp.acg-moe.com/)
+- [動漫御宅堂](http://syu65406.tw/anime/)
+- Feel free to submit yours in [`Let me know`](https://github.com/DIYgod/DPlayer/issues/31)
+
+## CDN
+
+[unpkg](https://unpkg.com/dplayer)
+
+[cdnjs](https://cdnjs.com/libraries/dplayer)
+
+[BootCDN](http://www.bootcdn.cn/dplayer/)
+
+[RawGit](https://rawgit.com/DIYgod/DPlayer/master/dist/DPlayer.min.js)
+
+## Donate
+
+- [Donate via Paypal](https://www.paypal.me/DIYgod)
+- [Donate via WeChat Pay](https://ws4.sinaimg.cn/large/006tKfTcgy1fhu1uowywej307s07st8h.jpg)
+- [Donate via Alipay](https://ws4.sinaimg.cn/large/006tKfTcgy1fhu1vf4ih7j307s07sdfm.jpg)
+- Donate via Bitcoin: 13CwQLHzPYm2tewNMSJBeArbbRM5NSmCD1
+
+
+## Author
 
 
-## LICENSE
+**DPlayer** © [DIYgod](https://github.com/DIYgod), Released under the [MIT](./LICENSE) License.<br>
+Authored and maintained by DIYgod with help from contributors ([list](https://github.com/DIYgod/DPlayer/contributors)).
 
 
-[The Star And Thank Author License (SATA)](https://github.com/DIYgod/DPlayer/blob/master/LICENSE)
+> [Blog](https://www.anotherhome.net) · GitHub [@DIYgod](https://github.com/DIYgod) · Twitter [@DIYgod](https://twitter.com/DIYgod) · Weibo [@DIYgod酱](http://weibo.com/anotherhome) · Telegram Channel [某不科学的DIYgod](https://t.me/awesomeDIYgod)