Skip to content

Commit dd59f7a

Browse files
committed
Rename package name CommentCoreLibrary => comment_core_library
Add Installing section to README.md nmp 只接受发布名称全部由小写字母构成的包
1 parent 73f163c commit dd59f7a

File tree

2 files changed

+34
-12
lines changed

2 files changed

+34
-12
lines changed

README.md

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,51 @@
11
# CommentCoreLibrary 弹幕核心通用构件
22
The CommentCoreLibrary is a set of Javascript modules that make up the
3-
core controller for comments streaming on top of timed media (video or audio).
4-
It is intended as a catalyst for the development of timed "danmaku" comments
3+
core controller for comments streaming on top of timed media (video or audio).
4+
It is intended as a catalyst for the development of timed "danmaku" comments
55
in HTML5.
66

7-
Developers willing to incorporate similar comment streaming functionalities
8-
inside their own projects (whether web based or not) are encouraged to learn
7+
Developers willing to incorporate similar comment streaming functionalities
8+
inside their own projects (whether web based or not) are encouraged to learn
99
from and extend from the CommentCoreLibrary.
1010

1111
## Testing
12-
We have a live demo [here](http://jabbany.github.com/CommentCoreLibrary/demo).
13-
Feel free to [open tickets](CONTRIBUTING.md) if this demo test has bugs.
12+
We have a live demo [here](http://jabbany.github.com/CommentCoreLibrary/demo).
13+
Feel free to [open tickets](CONTRIBUTING.md) if this demo test has bugs.
1414

1515
## License
1616
The CommentCoreLibrary is licensed under the permissive MIT License. If you wish
1717
to use this in any project, you can simply include the following line:
1818

1919
CommentCoreLibrary (//github.com/jabbany/CommentCoreLibrary) - Licensed under the MIT license
2020

21+
## Installing
22+
With [bower](http://bower.io/)
23+
`bower install comment_core_library`
24+
25+
With [npm](https://www.npmjs.org/)
26+
`npm install commet_core_library`
27+
28+
For Rails, installing with [rails-assets](https://rails-assets.org/) is recommended
29+
In Gemfile:
30+
```ruby
31+
# Add https://rails-assets.org as the new gem source
32+
source 'https://rails-assets.org'
33+
34+
gem 'rails-assets-comment_core_library'
35+
```
36+
2137
## Examples and Documentation
22-
- Documentation can be found inside the `docs/` folder.
38+
- Documentation can be found inside the `docs/` folder.
2339
- Some sample extension modules may be found in `extend/`.
2440
- Experimental modules are in `experimental/`.
2541
- You may test using test data found in `tests/`.
2642

2743
## Contributing
28-
We encourage any contributions to this project, please read
44+
We encourage any contributions to this project, please read
2945
[CONTRIBUTING](CONTRIBUTING.md) for details on how to contribute to the project.
3046

31-
Also, feel free to have a look at our sister project
32-
[ABPlayerHTML5](https://github.com/jabbany/ABPlayerHTML5) for a reference
47+
Also, feel free to have a look at our sister project
48+
[ABPlayerHTML5](https://github.com/jabbany/ABPlayerHTML5) for a reference
3349
implementation of a video player with CommentCoreLibrary.
3450

3551
# 弹幕核心通用构件
@@ -38,7 +54,7 @@ implementation of a video player with CommentCoreLibrary.
3854
自己的流媒体注释播放模式。
3955

4056
不管你在开发基于Javascript的Web服务,还是其他的需要弹幕播放功能服务,都可以参考弹幕核心
41-
的实现代码。我们以简单的方法构建了 (1) 时间轴管理 (2) 基础空间规划 (3) 弹幕过滤 (4)
57+
的实现代码。我们以简单的方法构建了 (1) 时间轴管理 (2) 基础空间规划 (3) 弹幕过滤 (4)
4258
高级弹幕效果 (5) 基础格式解析 (6) 代码弹幕支持
4359

4460
## 测试

package.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
{
2-
"name": "CommentCoreLibrary",
2+
"name": "comment_core_library",
33
"description": "Extendable library for displaying danmaku comments.",
44
"bugs": {
55
"url": "https://github.com/jabbany/CommentCoreLibrary/issues",
66
"email": "knh.jabbany@gmail.com"
77
},
8+
"repository" : {
9+
"type": "git",
10+
"url": "https://github.com/jabbany/CommentCoreLibrary.git"
11+
},
12+
"author": "Jim Chen <knh.jabbany@gmail.com>",
13+
"keywords": ["danmaku", "video", "comments", "CommentCoreLibrary"],
814
"license":"MIT",
915
"version": "0.9.0",
1016
"devDependencies": {

0 commit comments

Comments
 (0)