Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.53 KB

README.md

File metadata and controls

54 lines (37 loc) · 1.53 KB

gitzz

Build Status Coverage Status
author

The Gitzz is a JavaScript library that helps you easily parse Github's commit data.

Links

Getting Started

Installation

npm install gitzz
yarn add gitzz

Usage

Basics

// Getting today commit count
const todayCommit: number = await getDayCommitCount('username')

// All methods in gitzz return null on invalid requests.
if (!todayCommit) throw something...

// and enjoy it
console.log(todayCommit)

Methods

  • Getting commit counts via
    • getDayCommitCount, getYesterdayCommitCount, getMonthCommitCount, getYearCommitCount
  • Parsing Github page for using jquery
    • requestUserToGithub, requestOrgToGithub
  • also, you can get all commit stats with a method getCommitStatistics
  • need organization's commit count? use getOrganizationCommitCount

License

gitzz is licensed under a MIT License.