Skip to content

Commit a0d5333

Browse files
initial readme
1 parent 191f73c commit a0d5333

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,15 @@
11
# github-contributors
22
Analyze and archive GitHub repo contributors
3+
4+
# Usage
5+
6+
## Create a leaderboard of github contributors for all the repos of a user/org
7+
(Contributor with highest # of contributions at the top)
8+
9+
Run `node contributors.js` from your terminal
10+
11+
This will
12+
* Fetch data from Github APIs and prepare a leaderboard of all the contributors to (default "Git-Commit-Show" org) the user or org you mention in `contributors.js`
13+
* Save the leaderboard in a csv file in the same folder
14+
15+
You will hit the API limits soon. To increase API limits, add GITHUB_PERSONAL_TOKEN in `contributors.js`

0 commit comments

Comments
 (0)