update readme

This commit is contained in:
alsotang 2014-08-29 11:58:11 +08:00
parent e32edaff6a
commit d733fe6cd0
3 changed files with 16 additions and 44 deletions

View File

@ -1,7 +1,6 @@
TESTS = $(shell find test -type f -name "*.test.js")
TESTTIMEOUT = 5000
REPORTER = spec
JSCOVERAGE = ./node_modules/jscover/bin/jscover
REGISTRY = "--registry=http://registry.npm.taobao.org"

View File

@ -1,5 +1,5 @@
nodeclub
=============
Nodeclub
=
[![build status][travis-image]][travis-url]
[![David deps][david-image]][david-url]
@ -12,63 +12,36 @@ nodeclub
[node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square
[node-url]: http://nodejs.org/download/
基于nodejs的社区系统。可访问 http://cnodejs.org/ 查看。
## 介绍
Node Club 是用 **Node.js****MongoDB** 开发的新型社区软件,界面优雅,功能丰富,小巧迅速,
已在Node.js 中文技术社区 [CNode](http://cnodejs.org) 得到应用,但你完全可以用它搭建自己的社区。
Nodeclub 是使用 **Node.js****MongoDB** 开发的社区系统,界面优雅,功能丰富,小巧迅速,
已在Node.js 中文技术社区 [CNode(http://cnodejs.org)](http://cnodejs.org) 得到应用,但你完全可以用它搭建自己的社区。
## 安装部署
```bash
// install node npm mongodb
// run mongod
$ npm install
$ cp config.default.js config.js
// modify the config file as yours
$ node app.js
```
1. install `node.js` `mongodb`
2. run mongod
3. `$ make install` 安装 Nodeclub 的依赖包
4. `$ cp config.default.js config.js` 使用默认的配置文件
5. `$ node app.js`
6. done!
```
## TEST
## 贡献
跑测试
```bash
$ make test
```
jscoverage
跑覆盖率测试
```bash
$ make test-cov
```
## 关于pull request
从现在开始,所有提交都要严格遵循[代码规范](https://github.com/dead-horse/node-style-guide)。
## Contributors
Below is the output from `git-summary`. Only first ten.
```bash
$ git summary
project : nodeclub
repo age : 2 years, 3 months
active : 244 days
commits : 632
files : 224
authors :
203 fengmk2 32.1%
111 Alsotang 17.6%
98 jiyinyiyong 15.5%
49 Jackson Tian 7.8%
30 dead-horse 4.7%
24 alsotang 3.8%
10 Kenny Zhao 1.6%
10 Lei Zongmin 1.6%
```
## License
MIT

View File

@ -116,7 +116,7 @@
<p>本社区为开源系统,版本: <%= config.version %> ,欢迎贡献代码</p>
<p>本站服务器由<a href="http://www.ucloud.cn/"><img src="/public/images/ucloud.png" title="UCloud云主机"
<p>本站服务器由<a href="http://www.ucloud.cn/?ref=cnode"><img src="/public/images/ucloud.png" title="UCloud云主机"
alt="UCloud云主机"
height="28px" width="92px"/></a>
赞助</p>