Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 3.31 KB

README.md

File metadata and controls

74 lines (53 loc) · 3.31 KB

GitHub Contributions

GitHub issues GitHub all releases GitHub release (latest by date)

A menubar app, which shows github contributions chart for the last 7 days, similar to the one on the github's user page:

screenshot1

When clicked it shows some information about the user:

screenshot2

Customizations

When creating a spoon you can customize how it looks like by passing optional parameters descibed below.

Icons

You can change default square icon to any character, like

circle ('●'): classic

star ('★'): classic

Themes

You can also change colors of icons, by using one of the following color themes:

theme name screenshot
classic classic
dracula dracula
leftpad leftpad
pink pink
teal teal

Installation

  • install Hammerspoon - a powerful automation tool for OS X
    • Manually:

      Download the latest release, and drag Hammerspoon.app from your Downloads folder to Applications.

    • Homebrew:

      brew install hammerspoon --cask

  • download github-contributions.spoon, unzip and double click on a .spoon file. It will be installed under ~/.hammerspoon/Spoons folder.
  • open ~/.hammerspoon/init.lua and add the following snippet:
-- github contributions
hs.loadSpoon("github-contributions")
spoon['github-contributions']:setup({
  usernames = {'streetturtle', 'fork-my-spoons', 'mgubaidullin'}, -- use one or multiple accounts
  -- theme = 'pink',
  -- char = '★'
})
spoon['github-contributions']:start()