JonasDoesThings / github-contributions

A library for fetching a GitHub user's contribution graph.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

github-contributions

A simple TypeScript library to fetch GitHub's contribution chart for a user

LICENSE npm version

Installation

npm install @jonasdoesthings/github-contributions
or
yarn add @jonasdoesthings/github-contributions

Usage

import {fetchContributions} from '@jonasdoesthings/github-contributions';

fetchContributions("JonasDoesThings").then(contributions => {
  console.log(contributions)
});

fetchContributions("JonasDoesThings", 2021).then(contributions => {
  console.log(contributions)
});

API

fetchContributions(username [string], <optional: year [number]>)
Returns: Promise<ContributionsYear>

License

The project is licensed under the MIT license.
Check the LICENSE file, for the full legal-notice.

About

A library for fetching a GitHub user's contribution graph.

License:MIT License


Languages

Language:TypeScript 88.4%Language:JavaScript 11.6%