Installation
- NPM
npm i @gwansikk/github-contributions
- Yarn
yarn add @gwansikk/github-contributions
Usage
[!IMPORTANT]
The current version is an unstable version, still under development, so there may be frequent changes to the code.
import { getContributions } from "@gwansikk/github-contributions";
const username = "gwansikk";
getContributions(username)
.then((contributions) => {
console.log(`GitHub Contributions for ${username}:`, contributions);
})
.catch((error) => {
console.error("Error fetching contributions:", error);
});
// getContributions(githubUsername) Output
{
'2022-12-18': 3,
'2022-12-25': 9,
,,, // more dates
'2023-12-02': 6,
'2023-12-09': 7,
}
Support
Type | Status | Version |
---|---|---|
Browsers | ✅ | <= 0.1.2 |
ES Modules | ✅ | <= 0.1.2 |
CommonJS | ✅ | <= 0.1.2 |
Contributing
Information describing how to contribute can be found in the file.
CONTRIBUTING.md