Skip to content

Contribution plotting from GitHub's feed

License

Notifications You must be signed in to change notification settings

akerl/githubchart

Repository files navigation

GithubChart

Gem Version GitHub Workflow Status MIT Licensed

Generates an SVG of your Github contributions:

Example image

Other user example

Usage

Run githubchart path/to/svg to generate an SVG. To override the default username (pulled from your local shell or .gitconfig), use githubchart -u username path/to/svg

GithubChart also allows you to provide input from a file instead of pulling data from Github. You can pass JSON to GithubChart by using githubchart -i /path/to/file /path/to/svg, or use '-' to use STDIN. See spec/examples/input.json for example data.

If you don't provide a file path, the resulting SVG will be printed to stdout.

To modify the color scheme used, you can provide -c SCHEME. For example, githubchart -c halloween uses GitHub's halloween colors. Use -s to list the available schemes.

Hosted SVG

A hosted service for loading these SVGs was made by 2016rshah: http://ghchart.rshah.org/ (source code)

Installation

gem install githubchart

License

githubchart is released under the MIT License. See the bundled LICENSE file for details.

About

Contribution plotting from GitHub's feed

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages