4.0.0 • Published 4 years ago
hacktoberfeststats v4.0.0
HacktoberfestStats
This Module can be used to retrieve all information about a given GitHub user within Hacktoberfest's event.
Dependencies:
- Request
- Underscore
- Meow
Installation:
npm install hacktoberfeststats
Usage:
CLI
npx hacktoberfeststats MatejMecka # current year
npx hacktoberfeststats MatejMecka -y 2018
npx hacktoberfeststats MatejMecka --year 2018
API
var Hacktoberfest = require('hacktoberfeststats')
Hacktoberfest("MatejMecka", "2018", function(hacktoberfestStats,error){
if (error) {
console.log(error.message)
} else {
console.log(hacktoberfestStats.mainStat)
}
})
Options:
The callback function receives an object that contains two properties:
mainStats:
- Name: The person’s first name or username
- Completed: Is it Completed or Not. Returns a boolean
- Progress: How many pull requests a user has made: ex:
11/4
- Contributions: Repositories where the user did pull requests
raw: an object with all information about GitHub user and his/her activities made in October.