Skip to content

Commit a962b14

Browse files
committed
add ci & update readme
1 parent a88b380 commit a962b14

File tree

3 files changed

+35
-13
lines changed

3 files changed

+35
-13
lines changed

README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,38 @@
66

77
<h1 align="center">v2ex-api-bridge</h1>
88

9+
<p align="center">
10+
<a href="https://circleci.com/gh/IndexXuan/v2ex-api-bridge/tree/master">
11+
<img src="https://circleci.com/gh/IndexXuan/v2ex-api-bridge/tree/master.svg?style=shield" alt="Build Status">
12+
</a>
13+
<img src="https://img.shields.io/badge/Vim-Best%20Editor-green.svg" alt="Vim Best Editor" />
14+
<br>
15+
<br>
16+
<a href="https://github.com/airbnb/javascript">
17+
<img src="https://cdn.rawgit.com/feross/standard/master/badge.svg" alt="js-standard-style">
18+
</a>
19+
</p>
20+
21+
922
## Intro
1023

11-
`V2EX API Bridge`: 提供论坛公开API的封装和私有API的挖掘实现,目前支持 `登录,签到,发帖,回帖` 等功能.  
24+
`V2EX API Bridge`: 提供论坛公开API的封装和私有API的挖掘实现,目前已支持 `登录,签到,发帖,回帖` 等非官方API功能.  
1225

13-
- 参考
14-
- [官方API] (https://www.v2ex.com/p/7v9TEc53)
15-
- [V2EX-API整理] (https://github.com/djyde/V2EX-API)
26+
- Thanks for
27+
- [official API] (https://www.v2ex.com/p/7v9TEc53)
28+
- [V2EX-API] (https://github.com/djyde/V2EX-API)
1629

1730
## Development
1831

32+
- require Node.js 7.6.0+ (async & await)
33+
- recommend yarn install
34+
- recommend [nvm](https://github.com/creationix/nvm) - the Node.js Version Manager
35+
1936
```bash
20-
$ npm install(recommend: yarn install)
37+
$ npm install
2138
$ npm run dev
2239
```
23-
24-
require Node.js 7.6.0+ (async & await)
25-
26-
* 可以在 `app/router.js` 中查看完整路由配置和demo示例链接
40+
* see `app/router.js` to find full router config & demo api links
2741

2842
## Features
2943

@@ -34,7 +48,7 @@ require Node.js 7.6.0+ (async & await)
3448

3549
## Unit Test
3650

37-
- `mocha`, `thunk-mocha`, `power-assert`, `istanbul` is build-in to [egg-bin], so you can just use it.
51+
- `mocha`, `thunk-mocha`, `power-assert`, `istanbul` is build-in to `egg-bin`, so you can just use it.
3852
- `power-assert` is very powerful, No API is the best API.
3953
- see [egg unit test docs](https://eggjs.org/core/unittest) for more detail.
4054

@@ -49,6 +63,7 @@ require Node.js 7.6.0+ (async & await)
4963
## Todo
5064

5165
- make `pwa` using the APIs
66+
- parse the `response html` to get more private APIs
5267

5368
## Links
5469

circle.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
machine:
2+
node:
3+
version: 7
4+
5+
test:
6+
override:
7+
- npm run test

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "v2ex-api-bridge",
33
"version": "1.0.0",
4-
"description": "V2EX APIs powered by egg(Node.js >= 7.6) with full unit test",
4+
"description": "V2EX APIs powered by Egg(Node.js 7.6.0+) with full unit test",
55
"private": true,
66
"scripts": {
77
"start": "node index.js",
@@ -29,9 +29,9 @@
2929
"url": "https://github.com/IndexXuan/v2ex-api"
3030
},
3131
"keywords": [
32-
"v2ex",
32+
"V2EX",
3333
"RESTful API",
34-
"egg",
34+
"Egg",
3535
"async-await",
3636
"unittest"
3737
],

0 commit comments

Comments
 (0)