Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
“inoueb” committed Nov 14, 2020
1 parent 63412ea commit e05557f
Showing 1 changed file with 3 additions and 15 deletions.
18 changes: 3 additions & 15 deletions README.md
Expand Up @@ -2,27 +2,15 @@

Run this command:
```
go install -mod=vendor ./... && oss-contribution-checker --account {your github account name}
go install -mod=vendor ./... && oss-contribution-checker --account {github account name}
```
Requirement:
- need to have `.git-neco.yml` in your home directory or `token.txt` in the current directory which contains a github personal token.
- need to have `token.txt` in the current directory which contains a github personal token or pass your github api token to `--token` option.

Output:
```
# list of your issues and prs
title: {your issue/pr's title}, year: {created yaer}, repositoryURL: {issue/pr's repository}, needToExclude; {excluded from the summery}
...
Summery:
# of Issues:
...
# of PRs:
...
```
- It may contain personal info, so no example is provided here. Check it by yourself:D

TODO
- リポジトリ別の件数
- PRはマージされたかどうかの情報
- 働きっぷりの可視化
- render json
- summary option(year. project)

0 comments on commit e05557f

Please sign in to comment.