https://github.com/gwansikk/github-users

🌿 Easily and quickly access information of Github Users.
https://github.com/gwansikk/github-users

github

Last synced: about 1 month ago
JSON representation

🌿 Easily and quickly access information of Github Users.

• Host: GitHub
• URL: https://github.com/gwansikk/github-users
• Owner: gwansikk
• License: mit
• Archived: true
• Created: 2023-12-01T15:34:35.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-07T02:32:14.000Z (10 months ago)
• Last Synced: 2025-04-20T11:38:58.269Z (about 1 month ago)
• Topics: github
• Language: TypeScript
• Homepage:
• Size: 1010 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README-ko_kr.md
  • License: LICENSE

Awesome Lists containing this project

README

        


🌿 github-contributions

GitHub 사용자의 기여도를 빠르고 쉽게 확인할 수 있습니다.


[![npm version](https://img.shields.io/npm/v/@gwansikk/github-contributions?logo=npm)](https://www.npmjs.com/package/@gwansikk/github-contributions)

[![npm downloads](https://img.shields.io/npm/dt/@gwansikk/github-contributions?logo=npm)](https://www.npmjs.com/package/@gwansikk/github-contributions)

[![npm bundle size](https://img.shields.io/bundlephobia/min/@gwansikk/github-contributions?logo=npm)](https://www.npmjs.com/package/@gwansikk/github-contributions)

[English](./README.md)

  •  

[한국어](./README-ko_kr.md)



## Installation

- NPM

```bash

npm i @gwansikk/github-contributions

```

- Yarn

```bash

yarn add @gwansikk/github-contributions

```

## Usage

> [!IMPORTANT]\

> 현재 버전은 아직 개발 중인 불안정한 버전이므로 코드에 자주 변경이 있을 수 있습니다.

```javascript

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);

  });

```

```javascript

// getContributions(githubUsername) Output

{

  '2022-12-18': 3,

  '2022-12-25': 9,

  ,,, // more dates

  '2023-12-02': 6,

  '2023-12-09': 7,

}

```

## Contributing

해당 프로젝트에 기여하고 싶다면 아래 문서를 참고해주세요.  

[CONTRIBUTING.md](./CONTRIBUTING.md)