Skip to content

Commit

Permalink
doc: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jaywcjlove committed Apr 17, 2024
1 parent 462f2d7 commit 86c1bef
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 60 deletions.
48 changes: 18 additions & 30 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,29 +29,6 @@ Github 全球/中国用户排名,全球仓库 Star 最多排名,通过 Githu

更新时间:<!--GAMFC-->2022-11-05 09:15:32<!--GAMFC-END-->

## Development

```bash
$ git clone https://github.com/jaywcjlove/github-rank.git
$ cd github-rank
$ npm install # 安装依赖
```

获取数据

```bash
$ npm npm run get:trending # 获取 trending 数据
$ npm npm run get:repos # 获取 repos 数据
$ npm npm run get:users # 获取 users 数据
$ npm npm run get:users:china # 获取 users(china) 数据
```

生成 HTML 页面

```bash
$ npm run start
```

## 插件使用

```bash
Expand Down Expand Up @@ -111,17 +88,28 @@ import users from '@wcj/github-rank';
]
```

## 获取数据
## 开发

```bash
$ git clone https://github.com/jaywcjlove/github-rank.git
$ cd github-rank
$ npm install # 安装依赖
$ npm run build # 编译输出脚本
```

获取数据

```bash
# 获取 Github (中国/全球)用户排行榜(Top 500)
npm run get
$ npm npm run get:trending # 获取 trending 数据
$ npm npm run get:repos # 获取 repos 数据
$ npm npm run get:users # 获取 users 数据
$ npm npm run get:users:china # 获取 users(china) 数据
```

# Github 用户获取中途失败,接着获取剩余用户信息
npm run get:users:info
生成 HTML 页面

# 获取 Github 趋势榜,Github 仓库排行(Top 500), sifou,toutiao 的数据
npm run get:o
```bash
$ npm run start
```

## 感谢所有贡献者
Expand Down
48 changes: 18 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,29 +29,6 @@ Now it can be updated automatically every day, using [GitHub Actions Workflows](

Update date: <!--GAMFC-->2024-04-17 20:44:29<!--GAMFC-END-->

## Development

```bash
$ git clone https://github.com/jaywcjlove/github-rank.git
$ cd github-rank
$ npm install # Install dependencies
```

Get data

```bash
$ npm npm run get:trending # Get trending data
$ npm npm run get:repos # Get repos data
$ npm npm run get:users # Get users data
$ npm npm run get:users:china # Get users(china) data
```

Generate HTML page

```bash
$ npm run start
```

## Plug-in Usage

```bash
Expand Down Expand Up @@ -111,17 +88,28 @@ import users from '@wcj/github-rank';
]
```

## Crawlers get data
## Development

```bash
$ git clone https://github.com/jaywcjlove/github-rank.git
$ cd github-rank
$ npm install # Install dependencies
$ npm run build # Compilation output script
```

Crawlers get data

```bash
# Get Github (China/Global) user rankings (Top 900)
npm run get
$ npm npm run get:trending # Get trending data
$ npm npm run get:repos # Get repos data
$ npm npm run get:users # Get users data
$ npm npm run get:users:china # Get users(china) data
```

# Github user acquisition fails in the middle, and then the remaining user information is acquired
npm run get:users:info
Generate HTML page

# Get Github trend list, Github repository ranking (Top 500) data
npm run get:o
```bash
$ npm run start
```

## Contributors
Expand Down

0 comments on commit 86c1bef

Please sign in to comment.