Skip to content

A lightweight React component to display a graph of Github contributions

License

Notifications You must be signed in to change notification settings

kylekarpack/react-github-graph

Repository files navigation

react-github-graph

React Github Graph Sample

Purpose

React Github Graph is a lightweight React component that displays Github contributions for a given user.

Installation

npm install react-github-graph

or

yarn add react-github-graph

Usage

import React from "react";
import { GithubContributions } from "react-github-graph"

export default function App() {
  return (
    <GithubContributions username="{your username here}" />
  );
}

Notes

Currently depends on the following resources:

If one of these resources is unavailable, the component will not be able to load and will hide itself