Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yshnb committed May 10, 2015
1 parent 1b81f9d commit 9ef01e3
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
# github-stat-script

tutorial for myself to write in golang and to use [go-github](https://github.com/google/go-github)

## Usage

1. `git clone https://github.com/yshnb/github-stat-script.git`
2. `cd ./github-stat-script`
3. fill in valid `accessToken` from Github

After, you can run the below command
```
$ go run main.go --metrics=star google/go-github
target repository: google/go-github
metrics: star
star: 1079
```
like this.

## Available metrics

For now, it can only get the numbers of github star in each repository.

My plan ....

- issue
- pull_requests (open/closed)
- code changes(additions/deletions)
- etc.

0 comments on commit 9ef01e3

Please sign in to comment.